bmc.kepler.Accessor

属性

属性名	类型	可读写	信号通知	描述
`Value`	`U64`	读写	变更广播	Accessor的值
`Status`	`U8`	只读	变更广播	Accessor状态, 0: 正常获取值, 1: 获取值失败, 2: 获取值预失败,正在进行防抖, 3: 处于无效状态, 4: 初始状态, 暂未开始获取值

bmc.kepler.AccountService

属性

属性名	类型	可读写	信号通知	描述
`AccountLockoutCounterResetAfter`	`S32`	读写	变更广播	账户上次登陆失败后，锁定计数器重置剩余时间
`AccountLockoutCounterResetEnabled`	`Boolean`	读写	变更广播	账户在AccountLockoutCounterResetAfter到期后是否重置
`AuthFailureLoggingThreshold`	`S32`	读写	变更广播	未使用
`MaxPasswordLength`	`S32`	只读	变更广播	密码最长默认为20位
`MinPasswordLength`	`S32`	读写	变更广播	密码最短长度
`ServiceEnabled`	`Boolean`	读写	变更广播	未使用
`PasswordComplexityEnable`	`Boolean`	读写	变更广播	密码复杂度检查开关
`InitialPasswordPromptEnable`	`Boolean`	读写	变更广播	BMC支持生产定制化关闭首次登录修改密码提示功能
`InitialAccountPrivilegeRestrictEnabled`	`Boolean`	读写	变更广播	初始账户权限限制开关
`MinPasswordValidDays`	`U32`	读写	变更广播	密码最短有效期
`MaxPasswordValidDays`	`U32`	读写	变更广播	密码最长有效期
`EmergencyLoginAccountId`	`U8`	读写	变更广播	逃生用户
`SNMPv3TrapAccountId`	`U8`	读写	变更广播	SNMPv3Trap用户
`InactiveDaysThreshold`	`U32`	读写	变更广播	用户不活跃阈值
`WeakPasswordDictionaryEnabled`	`Boolean`	读写	变更广播	弱口令字典使能开关
`HistoryPasswordCount`	`U8`	读写	变更广播	检查历史密码数
`InitialPasswordNeedModify`	`Boolean`	读写	变更广播	初始密码需要强制修改
`HostUserManagementEnabled`	`Boolean`	读写	变更广播	业务侧用户管理使能
`OSAdministratorPrivilegeEnabled`	`Boolean`	读写	变更广播	业务侧管理员权限使能:true表示允许执行业务侧发送的（权限为用户管理、安全配置、调试诊断的）ipmi命令；false表示禁止执行业务侧发送的（权限为用户管理、安全配置、调试诊断）ipmi命令
`SNMPv3TrapAccountLimitPolicy`	`U8`	读写	变更广播	根据trap使能状态和版本,调整对snmpv3trap用户的修改策略.
`UserNamePasswordPrefixCompareEnabled`	`Boolean`	读写	变更广播	密码与用户名前n个字节比较策略使能
`UserNamePasswordPrefixCompareLength`	`U8`	读写	变更广播	密码与用户名前n个字节比较策略长度

方法

`ImportWeakPasswordDictionary`

输入参数：

参数名	类型	描述
`Path`	`String`

输出参数：

参数名	类型	描述
`TaskId`	`U32`	仅远程上传涉及，任务id

`ExportWeakPasswordDictionary`

输入参数：

参数名	类型	描述
`Path`	`String`

输出参数：

参数名	类型	描述
`TaskId`	`U32`	仅远程上传涉及，任务id

`GetRequestedPublicKey`

输入参数：

参数名	类型	描述
`PublicKeyUsageType`	`U8`	公钥用途，当前将支持web前端加密公钥：1

输出参数：

参数名	类型	描述
`PublicKey`	`String`	公钥字符串

`RecoverAccount`

输入参数：

参数名	类型	描述
`AccountId`	`U8`
`Policy`	`U8`

bmc.kepler.AccountService.AccountPolicy

属性

属性名	类型	可读写	信号通知	描述
`NamePattern`	`String`	读写	变更广播	用户名正则规则

bmc.kepler.AccountService.Authentication

属性

属性名	类型	可读写	信号通知	描述
`AccountLockoutDuration`	`S32`	读写	变更广播	账户登录失败后锁定时长,单位为秒
`AccountLockoutThreshold`	`S32`	读写	变更广播	账户登录失败该次数后被锁定
`AccountLockoutCounterResetAfter`	`S32`	读写	变更广播	账户上次登录失败与重置锁定阈值计数间的时间间隔,单位为秒
`LocalAccountAuth`	`String`	读写	变更广播	指示如何使用账户服务中的账户集合作为身份验证的一部分

方法

`Authenticate`

输入参数：

参数名	类型	描述
`UserName`	`String`
`Password`	`U8[]`
`Domain`	`String`

输出参数：

参数名	类型	描述
`UserId`	`S32`
`Privileges`	`String[]`
`RoleId`	`U8`
`ExtraData`	`ExtraDataDict`

自定义类型

AuthType 枚举：

字段名	类型	数值
Local	Enum	0
ldap_auto_match	Enum	1
ldap_server1	Enum	2
ldap_server2	Enum	3
ldap_server3	Enum	4
ldap_server4	Enum	5
ldap_server5	Enum	6
ldap_server6	Enum	7
ldap_kerberos_sso	Enum	12
kerberos_server	Enum	13
sso_local	Enum	14
sso_ldap	Enum	15
auto_match	Enum	255

RmcpAuthAlgo 枚举：

字段名	类型	数值
None	Enum	0
HmacSha1	Enum	1
HmacMd5	Enum	2
HmacSha2	Enum	3

SessionLogoutType 枚举：

字段名	类型	数值
SessionLogout	Enum	0
SessionTimeout	Enum	1
SessionKickout	Enum	2
SessionRelogin	Enum	3
AccountConfigChange	Enum	4
BMCConfigChange	Enum	5

ExtraDataDict 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.AccountService.Authentication.RMCP

方法

`GenRakp2AuthCode`

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`UserName`	`String`
`ConsoleSid`	`U32`
`ManagedSid`	`U32`
`ConsoleRandom`	`U8[]`
`ManagedRandom`	`U8[]`
`ManagedGuid`	`U8[]`
`Role`	`U8`
`Ip`	`String`

输出参数：

参数名	类型	描述
`AuthCode`	`U8[]`

`AuthRakp3`

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`UserName`	`String`
`ManagedRandom`	`U8[]`
`ConsoleSid`	`U32`
`Role`	`U8`
`AuthCode`	`U8[]`
`Ip`	`String`

`GenSik`

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`UserName`	`String`
`ConsoleRandom`	`U8[]`
`ManagedRandom`	`U8[]`
`Role`	`U8`
`Ip`	`String`

输出参数：

参数名	类型	描述
`AuthCode`	`U8[]`

`GenRmcpAuthCode`

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`PayLoad`	`U8[]`
`UserId`	`U8`
`SessionId`	`U32`
`SessionSequence`	`U32`
`Ip`	`String`

输出参数：

参数名	类型	描述
`AuthCode`	`U8[]`

`CheckRmcpAuthCode`

描述： IPMI1.5版本用户认证方法

输入参数：

参数名	类型	描述
`AuthCode`	`U8[]`
`AuthAlgo`	`U8`
`PayLoad`	`U8[]`
`UserId`	`U8`
`SessionId`	`U32`
`SessionSequence`	`U32`

bmc.kepler.AccountService.Authorization

方法

`LoginRuleCheck`

输入参数：

参数名	类型	描述
`UserName`	`String`

bmc.kepler.AccountService.CertificateAuthentication

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	双因素认证使能(证书认证)
`OCSPEnabled`	`Boolean`	读写	变更广播	联机证书状态检查使能(Online Certificate Status Protocol)

bmc.kepler.AccountService.Kerberos

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	Kerberos使能
`Address`	`String`	读写	变更广播	Kerberos服务器地址
`Port`	`S32`	读写	变更广播	Kerberos端口
`Realm`	`String`	读写	变更广播	Kerberos领域

方法

`ImportKeyTable`

输入参数：

参数名	类型	描述
`Path`	`String`

bmc.kepler.AccountService.LDAP

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	LDAP使能

bmc.kepler.AccountService.LDAP.LDAPController

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	LDAP域控制器使能
`HostAddr`	`String`	读写	变更广播	LDAP服务器地址
`Port`	`S32`	读写	变更广播	LDAPS端口
`UserDomain`	`String`	读写	变更广播	LDAP服务域名
`Folder`	`String`	读写	变更广播	用户应用文件夹
`BindDN`	`String`	读写	变更广播	代理用户
`CertVerifyEnabled`	`Boolean`	读写	变更广播	证书校验使能
`CertVerifyLevel`	`U8`	读写	变更广播	证书校验级别, 2-Demand, 3-Allow

方法

`SetBindDnPassword`

输入参数：

参数名	类型	描述
`Password`	`U8[]`

bmc.kepler.AccountService.LocalAccountAuthN

方法

`LocalAuthenticate`

输入参数：

参数名	类型	描述
`UserName`	`String`
`Password`	`U8[]`
`Config`	`Config`

输出参数：

参数名	类型	描述
`AccountData`	`AccountData`

`VncAuthenticate`

输入参数：

参数名	类型	描述
`CipherText`	`String`
`AuthChallenge`	`String`

输出参数：

参数名	类型	描述
`AccountData`	`AccountData`

`GenRmcp20Code`

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`UserName`	`String`
`ConsoleSid`	`U32`
`ManagedSid`	`U32`
`ConsoleRandom`	`U8[]`
`ManagedRandom`	`U8[]`
`ManagedGuid`	`U8[]`
`Role`	`U8`
`Ip`	`String`

输出参数：

参数名	类型	描述
`Rap2AuthCode`	`U8[]`
`Sik`	`U8[]`
`Rap3AuthCode`	`U8[]`

`GenRmcp15Code`

描述： IPMI1.5版本用户认证方法

输入参数：

参数名	类型	描述
`AuthAlgo`	`U8`
`PayLoad`	`U8[]`
`AccountId`	`U8`
`SessionId`	`U32`
`SessionSequence`	`U32`

输出参数：

参数名	类型	描述
`AuthCode`	`U8[]`

自定义类型

Config 结构：

字段名	类型	描述
key	String
value	Boolean

AccountData 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.AccountService.ManagerAccount

属性

属性名	类型	可读写	信号通知	描述
`AccountExpiration`	`String`	只读	变更广播	账户过期说明
`Certificates`	`U16`	只读	变更广播	证书认证证书Id
`Enabled`	`Boolean`	读写	变更广播	账户使能状态
`Id`	`U8`	只读	变更广播	账户Id
`Locked`	`Boolean`	只读	变更广播	账户锁定状态
`UserName`	`String`	读写	变更广播	账户名
`Deletable`	`Boolean`	只读	变更广播	账户是否可以删除
`PasswordChangeRequired`	`Boolean`	读写	变更广播	密码初始状态
`PasswordExpiration`	`U32`	只读	变更广播	密码有效期（过期时间）
`RoleId`	`U8`	读写	变更广播	角色Id
`SshPublicKeyHash`	`String`	只读	变更广播	账户公钥hash值
`AccountType`	`String`	只读	变更广播	账户类型
`LoginRuleIds`	`String[]`	读写	变更广播	登录规则集合
`LastLoginTime`	`U32`	只读	变更广播	上次登录时间
`LastLoginIP`	`String`	只读	变更广播	上次登录IP
`LastLoginInterface`	`String`	只读	变更广播	上次登录接口
`FirstLoginPolicy`	`U8`	读写	变更广播	账户首次登陆口令修改策略
`Privileges`	`String[]`	只读	变更广播	账户拥有的实际权限
`LoginInterface`	`String[]`	读写	变更广播	账户可用登陆接口集合

方法

`Delete`

`ChangePwd`

输入参数：

参数名	类型	描述
`Password`	`U8[]`	待设置的密码

`ChangeSnmpPwd`

输入参数：

参数名	类型	描述
`Password`	`U8[]`	待设置的密码

`ImportSSHPublicKey`

输入参数：

参数名	类型	描述
`Type`	`String`	Content类型：URI/Text
`Content`	`String`	Type为URI时，代表远程路径/本地路径；Type为Text时，代表文本内容

输出参数：

参数名	类型	描述
`TaskId`	`U32`	远程上传时代表任务Id，否则为0

`DeleteSSHPublicKey`

`SetLastLogin`

输入参数：

参数名	类型	描述
`Ip`	`String`	上次登录IP
`Interface`	`String`	上次登录接口

输出参数：

参数名	类型	描述
`Result`	`U8`	处理结果

自定义类型

EnumLoginPolicy 枚举：

字段名	类型	数值
LP_Null	Enum	0
LP_PromptPasswordReset	Enum	1
LP_ForcePasswordReset	Enum	2

RoleType 枚举：

字段名	类型	数值
NoAccess	Enum	0
CommonUser	Enum	2
Operator	Enum	3
Administrator	Enum	4
CustomRole1	Enum	5
CustomRole2	Enum	6
CustomRole3	Enum	7
CustomRole4	Enum	8

EnumAccountType 枚举：

字段名	类型	数值
Local	Enum	0
LDAP	Enum	1
Kerberos	Enum	2
VNC	Enum	3
KVM	Enum	4
KerberosSSO	Enum	5
IPMI_INNER	Enum	6

EnumLoginInterface 枚举：

字段名	类型	数值
Invalid	Enum	0
Web	Enum	1
SNMP	Enum	2
IPMI	Enum	4
SSH	Enum	8
SFTP	Enum	16
Local	Enum	64
Redfish	Enum	128

EnumLoginRuleIds 枚举：

字段名	类型	数值
Rule_Invalid	Enum	0
Rule1	Enum	1
Rule2	Enum	2
Rule3	Enum	4

bmc.kepler.AccountService.ManagerAccount.SnmpUser

属性

属性名	类型	可读写	信号通知	描述
`AuthenticationProtocol`	`U8`	只读	变更广播	SNMP鉴权算法
`EncryptionProtocol`	`U8`	只读	变更广播	SNMP加密算法
`SnmpEncryptionPasswordInitialStatus`	`Boolean`	只读	变更广播	SNMP加密密码初始状态

方法

`SetAuthenticationProtocol`

输入参数：

参数名	类型	描述
`SNMPAuthenticationProtocol`	`U8`	SNMP鉴权算法
`AuthPassword`	`String`	SNMP鉴权密码
`EncryPassword`	`String`	SNMP加密密码

`SetEncryptionProtocol`

输入参数：

参数名	类型	描述
`SNMPEncryptionProtocol`	`U8`	SNMP加密算法

`GetSnmpKeys`

输出参数：

参数名	类型	描述
`AuthenticationKey`	`String`	SNMP鉴权密码 Ku
`EncryptionKey`	`String`	SNMP加密密码 Ku

自定义类型

SNMPAuthenticationProtocols 枚举：

字段名	类型	数值
None	Enum	0
MD5	Enum	1
SHA96	Enum	2
SHA224	Enum	3
SHA256	Enum	4
SHA384	Enum	5
SHA512	Enum	6

SNMPEncryptionProtocols 枚举：

字段名	类型	数值
None	Enum	0
DES	Enum	1
AES128	Enum	2
AES256	Enum	3

SNMPKuType 枚举：

字段名	类型	数值
Authentication	Enum	0
Encryption	Enum	1

bmc.kepler.AccountService.ManagerAccounts

方法

`New`

输入参数：

参数名	类型	描述
`AccountId`	`U8`
`UserName`	`String`
`Password`	`U8[]`
`RoleId`	`Enum`
`LoginInterface`	`Array`
`FirstLoginPolicy`	`Enum`

输出参数：

参数名	类型	描述
`AccountId`	`U8`

`NewOEMAccount`

输入参数：

参数名	类型	描述
`AccountId`	`U8`
`UserName`	`String`
`Password`	`String`
`ExtraData`	`ExtraData`

输出参数：

参数名	类型	描述
`AccountId`	`U8`

`GetIdByUserName`

输入参数：

参数名	类型	描述
`UserName`	`String`

输出参数：

参数名	类型	描述
`AccountId`	`U8`

`GetUidGidByUserName`

输入参数：

参数名	类型	描述
`UserName`	`String`

输出参数：

参数名	类型	描述
`UID`	`U32`
`GID`	`U32`

`SetAccountWritable`

输入参数：

参数名	类型	描述
`AccountId`	`U8`
`PropertiesWritable`	`PropertyWritable`

`GetAccountWritable`

输入参数：

参数名	类型	描述
`AccountId`	`U8`

输出参数：

参数名	类型	描述
`PropertiesWritable`	`PropertyWritable`

`SetAccountLockState`

输入参数：

参数名	类型	描述
`AccountId`	`U8`
`Lockstatus`	`Boolean`

自定义类型

RoleType 枚举：

字段名	类型	数值
NoAccess	Enum	0
CommonUser	Enum	2
Operator	Enum	3
Administrator	Enum	4
CustomRole1	Enum	5
CustomRole2	Enum	6
CustomRole3	Enum	7
CustomRole4	Enum	8

LoginInterfaceType 枚举：

字段名	类型	数值
Invalid	Enum	0
Web	Enum	1
SNMP	Enum	2
IPMI	Enum	4
SSH	Enum	8
SFTP	Enum	16
Local	Enum	64
Redfish	Enum	128

FirstLoginPolicy 枚举：

字段名	类型	数值
PromptPasswordReset	Enum	1
ForcePasswordReset	Enum	2

PropertyWritable 结构：

字段名	类型	描述
key	String
value	Boolean

ExtraData 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.AccountService.PasswordPolicy

属性

属性名	类型	可读写	信号通知	描述
`Policy`	`U8`	读写	变更广播	密码校验策略,以bit位区分,bit0 默认开关,bit1 指定开关,取值不可为0
`Pattern`	`String`	读写	变更广播	密码校验正则表达式

bmc.kepler.AccountService.RemoteGroup

属性

属性名	类型	可读写	信号通知	描述
`GroupType`	`U8`	只读	变更广播	用户组类别
`ControllerId`	`U8`	只读	变更广播	域控制器ID
`SID`	`String`	读写	变更广播	SID
`Name`	`String`	读写	变更广播	用户组名
`UserRoleId`	`U8`	读写	变更广播	用户组角色
`Folder`	`String`	读写	变更广播	组应用文件夹
`PermitRuleIds`	`String[]`	读写	变更广播	登录规则
`LoginInterface`	`String[]`	读写	变更广播	组登录接口

方法

`Delete`

描述： 删除远程认证组

bmc.kepler.AccountService.RemoteGroups

方法

`New`

描述： 新增远程认证组

输入参数：

参数名	类型	描述
`GroupType`	`U8`	用户组类别
`ControllerId`	`U8`	域控制器ID-外键
`MemberId`	`U8`	指定组在域中的id,若为0,则自增
`Name`	`String`	用户组名
`Folder`	`String`	组应用文件夹
`SID`	`String`	SID
`UserRoleId`	`U8`	组角色
`PermitRuleIds`	`String[]`	组登录规则
`LoginInterface`	`String[]`	组登录接口

输出参数：

参数名	类型	描述
`GroupId`	`String`

bmc.kepler.AccountService.RestrictedPrivileges

属性

属性名	类型	可读写	信号通知	描述
`UserMgmt`	`Boolean`	只读	变更广播	用户管理权限
`BasicSetting`	`Boolean`	只读	变更广播	常规设置权限
`KVMMgmt`	`Boolean`	只读	变更广播	远程控制权限
`VMMMgmt`	`Boolean`	只读	变更广播	远程媒体权限
`SecurityMgmt`	`Boolean`	只读	变更广播	安全配置权限
`PowerMgmt`	`Boolean`	只读	变更广播	电源控制权限
`DiagnoseMgmt`	`Boolean`	只读	变更广播	调试诊断权限
`ReadOnly`	`Boolean`	只读	变更广播	查询功能权限
`ConfigureSelf`	`Boolean`	只读	变更广播	配置自身权限

自定义类型

PrivilegeType 枚举：

字段名	类型	数值
UserMgmt	Enum	0
BasicSetting	Enum	1
KVMMgmt	Enum	2
VMMMgmt	Enum	3
SecurityMgmt	Enum	4
PowerMgmt	Enum	5
DiagnoseMgmt	Enum	6
ReadOnly	Enum	7
ConfigureSelf	Enum	8

bmc.kepler.AccountService.Role

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	角色的九大权限名称
`RolePrivilege`	`String[]`	只读	变更广播	角色的九大权限

方法

`SetRolePrivilege`

输入参数：

参数名	类型	描述
`PrivilegeType`	`U8`
`PrivilegeValue`	`Boolean`

bmc.kepler.AccountService.Rule

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	登录规则使能状态
`IpRule`	`String`	读写	变更广播	IP登录规则
`MacRule`	`String`	读写	变更广播	MAC地址登录规则
`TimeRule`	`String`	读写	变更广播	时间登录规则

bmc.kepler.Assembly

属性

属性名	类型	可读写	信号通知	描述
`HostName`	`String`	读写	变更广播	管理侧的主机名信息
`SystemGUID`	`String`	读写	变更广播	可读写属性，ipmi命令可以修改该属性的持久化类型，默认复位持久化
`DomainName`	`String`	读写	变更广播	DDNS域名服务器名称
`UUID`	`String`	只读	变更广播	设备GUID
`FQDN`	`String`	读写	变更广播	完全限定域名， FQDN由两部分组成:主机名.域名

bmc.kepler.AssetService.AssetChange

方法

`UpdateTrustStatus`

描述： 刷新可信资产基准信息

`GetTrustRecord`

描述： 获取资产可信状态

输出参数：

参数名	类型	描述
`List`	`String`	获取全量的可信资产变更记录,json格式输出

bmc.kepler.AssetService.AssetList

方法

`GetAssetList`

描述： 获取硬件资产清单的json字符串

输出参数：

参数名	类型	描述
`List`	`String`	硬件资产清单的json字符串

bmc.kepler.AssetService.TrustedSupplyChain

属性

属性名	类型	可读写	信号通知	描述
`CheckEnabled`	`Boolean`	读写	变更广播	供应链配置检查告警定制化配置

方法

`GetChangedEvents`

描述： 获取供应链配置检查产生变更的配置详情json字符串

输出参数：

参数名	类型	描述
`List`	`String`	供应链配置检查产生变更的配置详情json字符串

`ConfirmChangedEvents`

描述： 关闭供应链配置检查，清除告警

bmc.kepler.Bus

属性

属性名	类型	可读写	信号通知	描述
`AccessEnabled`	`Boolean`	只读	变更广播	链路状态，true:使能访问链路， false:禁止访问链路
`Timeout`	`U16`	只读	变更广播	超时时长，从链路不可访问恢复访问的剩余时长，单位：秒

方法

`SetAccessibility`

描述： 设置bus可访问状态

输入参数：

参数名	类型	描述
`Status`	`Boolean`	链路状态，true:使能访问链路， false:禁止访问链路
`DisableDuration`	`U16`	失效时长，单位: 秒，取值范围: [1, 1800]，该参数只有将链路从使能状态变为禁止状态时生效，到期自动使能链路访问

bmc.kepler.Bus.BlockIO

方法

`Read`

描述： 按字节读取总线从地址对应的硬件数据

输入参数：

参数名	类型	描述
`SlaveAddress`	`U8`	目标器件地址
`ReadLength`	`U32`	读取长度

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	读取的结果

`Write`

描述： 按字节将指定内容写入总线从地址对应的硬件内

输入参数：

参数名	类型	描述
`SlaveAddress`	`U8`	目标器件地址
`InData`	`U8[]`	写入器件的数据内容

`WriteRead`

描述： 按字节将指定内容写入总线从地址对应的硬件内，再按字节读取总线从地址对应的硬件数据

输入参数：

参数名	类型	描述
`SlaveAddress`	`U8`	目标器件地址
`InData`	`U8[]`	写入器件的数据内容
`ReadLength`	`U8`	读取的长度

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	按字节读取总线从地址对应的硬件数据

bmc.kepler.Bus.Jtag

属性

属性名	类型	可读写	信号通知	描述
`JlcTckRate`	`U8`	只读	变更广播	Tck分频比, 控制Jtag通道速率, 对应JLC_TCK_RATE寄存器, 取值范围0x03~0x7F。典型配置和Jtag速率关系: 0x03: 4分频, 25MHz; 0x07: 8分频, 12.5MHz; 0x09: 10分频, 10MHz; 0x27: 40分频, 2.5MHz; 0x31: 50分频, 2MHz, 默认值为0x31

bmc.kepler.CertificateService

属性

属性名	类型	可读写	信号通知	描述
`CertOverdueWarnDays`	`U32`	读写	变更广播	证书过期提前告警时间
`CRLOverdueWarnMode`	`String`	读写	变更广播	吊销列表过期提前告警模式
`CRLOverdueWarnDays`	`U32`	读写	变更广播	吊销列表过期提前告警时间
`CRLEnabled`	`Boolean`	读写	变更广播	证书吊销列表检查使能
`IsDefaultSSLCert`	`Boolean`	只读	变更广播	是否预置的SSL证书
`SSLCertAlgorithm`	`U8`	读写	变更广播	SSL证书算法，生成CSR签名时使用，0表示RSA，1表示ECC

方法

`GetCertPath`

描述： 某种类型证书的存储目录，type为0，默认是CA证书

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`

输出参数：

参数名	类型	描述
`Path`	`String`	某种类型证书的存储目录

`ImportCert`

描述： 导入证书，支持CA证书和SSL证书的导入，如果是SSL证书，那么必须是生成CSR之后签名的证书。自定义的SSL证书（带私钥的）使用ImportCertWithKey方法导入。路径为本地文件绝对路径（涉及导入接口的路径如果是本地文件，则必须为绝对路径，否则路径检查会出错；）。

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`
`Type`	`String`	文件导入类型，可以是text或URI。text表示文本内容导入，Content字段为证书内容，URI表示文件导入，可以是本地或者远程文件
`Content`	`String`	证书文本内容或者文件路径，和Type配合，指定文件
`Id`	`U32`	如果指定id则导入到对应的证书id下，如果id为0，则寻找一个可用id进行导入

输出参数：

参数名	类型	描述
`Id`	`U32`
`TaskId`	`U32`	仅远程上传涉及，任务id

`ImportCertWithKey`

描述： 只支持SSL证书导入，导入自定义带私钥证书，需要传入证书密码

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`
`Type`	`String`	文件导入类型，可以是text或URI。text表示文本内容导入，Content字段为证书内容，URI表示文件导入，可以是本地或者远程文件
`Content`	`String`	证书文本内容或者文件路径，和Type配合，指定文件
`Key`	`String`	证书文件密码，可以为空

输出参数：

参数名	类型	描述
`TaskId`	`U32`	仅远程上传涉及，任务id

`StartGenerateCSR`

描述： 开始生成CSR任务，内部会生成私钥加密保存在BMC中，会生成一个任务，返回任务id，任务状态在/bmc/kepler/CertificateService/TaskService/Tasks/中展示

输入参数：

参数名	类型	描述
`Country`	`String`
`State`	`String`
`Location`	`String`
`OrgName`	`String`
`OrgUnit`	`String`
`CommonName`	`String`
`AlternativeNames`	`String[]`	使用者可选名称

输出参数：

参数名	类型	描述
`FilePath`	`String`	文件预期生成的路径，在任务完成后，会在该路径生成csr文件
`TaskId`	`U32`

`ExportCSR`

描述： 导出已经生成的CSR，支持导出到本地tmp路径下或者远程路径下

输入参数：

参数名	类型	描述
`Path`	`String`	导出到本地路径和远程路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`

`ExportCertKeyByFIFO`

描述： 导出证书私钥到管道文件，异步线程触发，返回一个命名管道文件地址，目前只支持SSL证书，供ServiceMgmt使用

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`

输出参数：

参数名	类型	描述
`FilePath`	`String`

`DeleteCert`

描述： 删除证书

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`
`Id`	`U32`

`GetCertChainInfo`

描述： 获取证书链中各证书信息

输入参数：

参数名	类型	描述
`CertificateUsageType`	`Enum`
`Id`	`U32`

输出参数：

参数名	类型	描述
`CertInfo`	`String`

`SetDefaultSSLCertSubject`

描述： 设置预置证书校验信息

输入参数：

参数名	类型	描述
`Country`	`String`
`CommonName`	`String`
`OrgName`	`String`

`ImportCRL`

描述： 导入CA证书对应证书的吊销䈗表，必须存在对应证书

输入参数：

参数名	类型	描述
`Type`	`String`	文件导入类型，可以是text或URI。text表示文本内容导入，Content字段为证书内容，URI表示文件导入，可以是本地或者远程文件
`Content`	`String`	证书文本内容或者文件路径，和Type配合，指定文件
`CertId`	`U32`	如果不指定具体的证书id（CertId为0），则遍历所有的ca证书进行匹配，直到匹配为止

输出参数：

参数名	类型	描述
`TaskId`	`U32`	仅远程上传涉及，任务id

`GetCSRContent`

描述： 查询生成CSR任务状态，如果生成完成会返回CSR文件路径

输出参数：

参数名	类型	描述
`Status`	`Enum`
`Content`	`String`

`GetCSRProperty`

描述： 查询数据库中的CSR生成任务参数

输入参数：

参数名	类型	描述
`Property`	`String`

输出参数：

参数名	类型	描述
`Value`	`String`

`SetCSRProperty`

描述： 设置数据库中的CSR生成任务参数

输入参数：

参数名	类型	描述
`Property`	`CSRProperty`

自定义类型

CertificateType 枚举：

字段名	类型	数值
PEM	Enum	0
PEMchain	Enum	1
PKCS7	Enum	2

KeyUsage 枚举：

字段名	类型	数值
DigitalSignature	Enum	0
NonRepudiation	Enum	1
KeyEncipherment	Enum	2
DataEncipherment	Enum	3
KeyAgreement	Enum	4
KeyCertSign	Enum	5
CRLSigning	Enum	6
EncipherOnly	Enum	7
DecipherOnly	Enum	8
ServerAuthentication	Enum	9
ClientAuthentication	Enum	10
CodeSigning	Enum	11
EmailProtection	Enum	12
Timestamping	Enum	13
OCSPSigning	Enum	14

CertificateUsageType 枚举：

字段名	类型	数值
ManagerCACertificate	Enum	0
ManagerSSLCertificate	Enum	1
ManagerAccountCertificate	Enum	2
ManagerCMPCertificate	Enum	3

CertAlgorithm 枚举：

字段名	类型	数值
RSA	Enum	0
ECC	Enum	1
SM2	Enum	2

CertInChainType 枚举：

字段名	类型	数值
Root	Enum	0
Intermediate	Enum	1
Last	Enum	2

CertTaskStatus 枚举：

字段名	类型	数值
NotStart	Enum	1
Running	Enum	2
Failed	Enum	3
Success	Enum	4

CSRProperty 结构：

字段名	类型	描述
key	String	CSR 参数，Country、State等
value	String	对应CSR参数的值

bmc.kepler.CertificateService.CA

属性

属性名	类型	可读写	信号通知	描述
`Privilege`	`U32`	读写	变更广播	CA operate privilege,bit0 indicates whether it can be deleted

bmc.kepler.CertificateService.Certificate

属性

属性名	类型	可读写	信号通知	描述
`CertificateType`	`U32`	只读	变更广播	SecurityEnum.CertificateType, NoUse
`CertificateUsageType`	`U32`	只读	变更广播	SecurityEnum.CertificateUsageType
`Fingerprint`	`String`	只读	变更广播	资源路径
`FingerprintHashAlgorithm`	`String`	只读	变更广播	默认SHA256
`Issuer`	`String`	只读	变更广播	颁发者，签发者
`KeyUsage`	`U32[]`	只读	变更广播	SecurityEnum.KeyUsage
`SerialNumber`	`String`	只读	变更广播	序列号
`SignatureAlgorithm`	`String`	只读	变更广播	签名算法
`Subject`	`String`	只读	变更广播	颁发给，使用者
`ValidNotAfter`	`String`	只读	变更广播	The date when the certificate is no longer valid.
`ValidNotBefore`	`String`	只读	变更广播	The date when the certificate becomes valid.
`FilePath`	`String`	只读	变更广播	文件路径
`CommonName`	`String`	只读	变更广播	证书名，使用者CN字段
`CRLStartTime`	`String`	只读	变更广播	吊销列表有效期开始时间
`CRLExpireTime`	`String`	只读	变更广播	吊销列表有效期结束时间
`CertCount`	`U32`	只读	变更广播	证书链中证书个数，如果是单个证书大小为1
`KeyLength`	`U32`	只读	变更广播	秘钥长度

方法

`DeleteCRL`

描述： 删除对应证书的吊销列表，必须存在对应的吊销列表

自定义类型

CertificateUsageType 枚举：

字段名	类型	数值
ManagerCACertificate	Enum	0
ManagerSSLCertificate	Enum	1
ManagerAccountCertificate	Enum	2
ManagerCMPCertificate	Enum	3

bmc.kepler.CertificateService.Certificate.Account

属性

属性名	类型	可读写	信号通知	描述
`RootCertUploadedState`	`Boolean`	只读	变更广播	It indicates whether the issuer uploaded
`IssuerId`	`U32`	只读	变更广播	Issuer cert id
`RevokedState`	`Boolean`	只读	变更广播	It Indicates whether the cert is revoked
`RevokedDate`	`String`	只读	变更广播	The date the cert was revoked

bmc.kepler.CertificateService.Certificate.CA

属性

属性名	类型	可读写	信号通知	描述
`CRLStartTime`	`String`	只读	变更广播	吊销列表有效期开始时间
`CRLExpireTime`	`String`	只读	变更广播	吊销列表有效期结束时间

方法

`DeleteCRL`

描述： 删除对应证书的吊销列表，必须存在对应的吊销列表

`ImportCRL`

输入参数：

参数名	类型	描述
`Type`	`String`	文件导入类型，可以是text或URI。text表示文本内容导入，Content字段为证书内容，URI表示文件导入，可以是本地或者远程文件
`Content`	`String`	证书文本内容或者文件路径，和Type配合，指定文件

bmc.kepler.CertificateService.Certificate.Entity

属性

属性名	类型	可读写	信号通知	描述
`AlternativeNames`	`String[]`	读写	变更广播	使用者可选名称

bmc.kepler.CertificateService.CertificateLocation

属性

属性名	类型	可读写	信号通知	描述
`Paths`	`String[]`	只读	变更广播	资源路径

bmc.kepler.CertificateService.Renew

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	证书自动更新使能状态
`AuthType`	`U8`	读写	变更广播	CA服务器认证方式,1代表单向认证,2代表双向认证
`Address`	`String`	读写	变更广播	CA服务器地址
`Port`	`U16`	读写	变更广播	CA服务器端口
`CMPPath`	`String`	读写	变更广播	CA服务器CMP路径

方法

`Renew`

描述： 手动对接CA服务器更新证书

bmc.kepler.CertificateService.Renew.Subject

属性

属性名	类型	可读写	信号通知	描述
`Country`	`String`	读写	变更广播	国家
`State`	`String`	读写	变更广播	州、省份
`Location`	`String`	读写	变更广播	城市
`OrgName`	`String`	读写	变更广播	公司
`OrgUnit`	`String`	读写	变更广播	部门
`CommonName`	`String`	读写	变更广播	常用名
`InternalName`	`String`	读写	变更广播	内部名
`Email`	`String`	读写	变更广播	邮箱
`AlternativeNames`	`String[]`	读写	变更广播	使用者可选名称

bmc.kepler.Chassis

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	机框名
`IntrusionFlag`	`U8`	只读	变更广播	开箱事件标志开箱：0x01 关闭：0x0
`UidButtonPressed`	`U8`	只读	变更广播	UID按钮按下标志
`UidButtonLongPressed`	`U8`	只读	变更广播	UID按钮长按标志
`ChassisType`	`U8`	只读	变更广播	当前管理软件类型
`Location`	`String`	读写	变更广播	位置信息
`DeviceSpecication`	`Array`	只读	变更广播	设备最大数量集合
`TopologyConfigId`	`U16`	只读	变更广播	产品组网拓扑

自定义类型

DeviceMaxCount 结构：

字段名	类型	描述
DeviceName	String	设备名称
MaximumNum	U8	设备最大数量

bmc.kepler.Chassis.CoolingPolicies

方法

`GetSpecificPWM`

描述： 获取指定条件下环温策略控制PWM

输入参数：

参数名	类型	描述
`Medium`	`String`	介质:风冷、液冷
`PolicyType`	`U8`	曲线类型 1:Inlet 2:Disk
`SmartCoolingMode`	`String`	SmartCooling模式：节能、低噪、高性能、自定义、液冷
`Temperature`	`S16`	温度值

输出参数：

参数名	类型	描述
`ControlPWM`	`U8`	控制占空比

bmc.kepler.Chassis.Dimension

属性

属性名	类型	可读写	信号通知	描述
`HeightU`	`Double`	只读	变更广播	机框高度

bmc.kepler.Chassis.Enclosure

属性

属性名	类型	可读写	信号通知	描述
`CabinetSerialNumber`	`String`	只读	变更广播	机柜sn
`EnclosureSerialNumber`	`String`	只读	变更广播	机框sn

bmc.kepler.Chassis.EnergySavingMeasurement

属性

属性名	类型	可读写	信号通知	描述
`RevenueStartTime`	`U32`	只读	变更广播	收益度量起始时间（时间戳）

方法

`GetPolicyGuidances`

描述： 获取节能策略指导

输出参数：

参数名	类型	描述
`PolicyGuidanceData`	`Array`	节能策略指导数据

自定义类型

PolicyGuidance 结构：

字段名	类型	描述
Component	String	部件名
HealthPercent	U8	系统功率
CurrentPolicies	String[]	当前策略
RecommendedPolicies	String[]	推荐策略
Influence	String[]	影响

bmc.kepler.Chassis.EnergySavingScene

属性

属性名	类型	可读写	信号通知	描述
`CurrentScene`	`String`	读写	变更广播	智能节能场景，HPC表示高性能场景，LightWork表示轻量场景，Default表示默认场景，Current表示当前值
`Supported`	`Boolean`	读写	变更广播	是否支持智能节能配置，true表示支持，false表示不支持
`Scenes`	`String[]`	只读	变更广播	支持的智能节能配置场景，取值为HPC、LightWork、Default三个取值的任意组合

方法

`GetModeByScene`

描述： 根据查询的智能节能场景获取节能系统的模式以及各个模式下的对应的值

输入参数：

参数名	类型	描述
`Scene`	`String`	根据查询的智能节能场景对应节能系统的配置值

输出参数：

参数名	类型	描述
`Systems`	`System`	获取节能系统的模式以及各个模式下的对应的值

自定义类型

System 结构：

字段名	类型	描述
key	String
value	Parameters	节能系统

Parameters 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Chassis.FanGroup

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	风扇组Id
`FanSlots`	`U8[]`	只读	变更广播	风扇组内槽位号
`SpeedPercent`	`Double`	只读	变更广播	基于风扇组内风扇修正后的转速，并统一下发至所有风扇
`ExpectedSpeedPercent`	`Double`	读写	变更广播	风扇组分组下发转速

bmc.kepler.Chassis.FruCtrl

属性

属性名	类型	可读写	信号通知	描述
`PowerState`	`String`	只读	变更广播	整刀片上下电状态
`PowerOnStrategy`	`String`	读写	变更广播	整刀片通电开机策略
`PreviousPowerState`	`String`	只读	变更广播	记录启动之前的整机上下电状态，用于通电开机策略为LastState时查询上下电操作

方法

`PowerCtrl`

描述： 上下电操作

输入参数：

参数名	类型	描述
`OperateType`	`String`	操作类型
`RestartCause`	`String`	重启原因

输出参数：

参数名	类型	描述
`CmdResult`	`S32`	命令执行结果

`SetPowerOnStrategyExceptions`

描述： 配置例外通电开机策略

输入参数：

参数名	类型	描述
`Reason`	`String`	调用原因描述
`Execute`	`String`	例外通电开机策略 Yes: 下次重启执行通电开机 No: 下次重启不执行通电开机策略 None:下次重启清除额外的通电开机策略
`EffectivePeriod`	`String`	生效周期 Once:单次 Continuous:永久
`Priority`	`U8`	生效优先级 1-10 1:redfish(外部) 2:内部调用

输出参数：

参数名	类型	描述
`CmdResult`	`U32`	命令执行结果

bmc.kepler.Chassis.LanSwitch

方法

`LswReset`

描述： 复位交换板相关器件

输入参数：

参数名	类型	描述
`Device`	`U32`	交换板器件类型：1.chip、2.phy、3.all
`Type`	`U32`	交换板器件复位类型：1.hard reset、2.soft reset

`GetConfigInfo`

描述： 获取交换板器件网络配置状态

输出参数：

参数名	类型	描述
`Value`	`String`	交换板器件网络配置状态

bmc.kepler.Chassis.LeakDetection

属性

属性名	类型	可读写	信号通知	描述
`LeakState`	`U8`	只读	变更广播	漏液状态, 0:无漏液,1:轻微漏液,2:严重漏液
`LeakValvePolicy`	`U8`	只读	变更广播	漏液关断阀策略,0:不操作,1:自动关断
`LeakPowerPolicy`	`U8`	只读	变更广播	漏液上下电策略,0:不操作,1:自动下电
`Enabled`	`Boolean`	读写	变更广播	是否使能漏液动作,false:不使能,true:使能

方法

`SetLeakPolicy`

描述： 设置漏液后的应对策略

输入参数：

参数名	类型	描述
`LeakValvePolicy`	`U8`	漏液关断阀策略,0:不操作,1:自动关断,255:保持当前值
`LeakPowerPolicy`	`U8`	漏液下电策略,0:不操作,1:自动下电,255:保持当前值

bmc.kepler.Chassis.LeakDetection.LeakDetector

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	漏液检测点ID
`Name`	`String`	只读	变更广播	漏液检测点名称
`Enabled`	`Boolean`	读写	变更广播	是否使能漏液检测点,false:不使能,true:使能
`State`	`U8`	只读	变更广播	漏液状态,0:无漏液,1:轻微漏液(Warning),2:严重漏液(Critical)
`Health`	`U8`	只读	变更广播	漏液传感器状态,0:无漏液,1:有漏液

bmc.kepler.Chassis.PCIeSwitch

属性

属性名	类型	可读写	信号通知	描述
`UpgradeStatus`	`U8`	只读	变更广播	0 代表未在升级中，1 代表升级中，2 代表升级失败且硬件故障

bmc.kepler.Chassis.PowerOnLock

方法

`SetPowerOnLock`

描述： 整机上电锁

输入参数：

参数名	类型	描述
`PwrOnLocked`	`Boolean`	是否上电锁定:true:锁定 false:解锁
`Timeout`	`U32`	有效的超时时间(单位1s)范围10~3600s
`AppName`	`String`	模块App名
`Reason`	`String`	增加上电锁的原因描述

输出参数：

参数名	类型	描述
`CmdResult`	`U8`	函数执行结果

bmc.kepler.Chassis.PowerSubsystem.PowerSupplies

方法

`SetPsusFanMinPWM`

描述： 设置所有psu风扇最低转速（如果设置的最低转速高于电源风扇控制的转速时才生效）

输入参数：

参数名	类型	描述
`FanMinPWM`	`U8`	所有psu风扇的转速百分比

bmc.kepler.Chassis.PumpGroup

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	泵组Id
`PumpSlots`	`U8[]`	只读	变更广播	泵组内槽位号
`SpeedPercent`	`Double`	只读	变更广播	泵修正后的实际转速百分比
`ExpectedSpeedPercent`	`Double`	读写	变更广播	泵组分组下发转速百分比

bmc.kepler.Chassis.SensorSelInfo

属性

属性名	类型	可读写	信号通知	描述
`SelMode`	`U8`	读写	变更广播	SEL 记录的模式：0: 默认模式，记录达到最大数量后清空; 1: 记录达到最大数量后滚动
`RecordSeq`	`U64`	只读	变更广播	当前事件的序列号，随着事件产生无限递增

bmc.kepler.Chassis.Sensors

属性

属性名	类型	可读写	信号通知	描述
`Health`	`String`	只读	变更广播	系统健康状态,取值有0：Normal，1：Minor，2：Major，3：Critical

方法

`GetThresholdSensorList`

描述： 查询门限传感器列表

输出参数：

参数名	类型	描述
`SensorList`	`Array`	门限传感器列表

`MockSensor`

描述： 模拟传感器

输入参数：

参数名	类型	描述
`Enabled`	`U8`	是否使能模拟
`SensorName`	`String`	模拟传感器的名称
`Value`	`String`	模拟传感器读值，stop是停止模拟

`GetSensorList`

描述： 查询所有传感器列表

输出参数：

参数名	类型	描述
`SensorList`	`Array`	查询到的传感器列表

`SetSensorStatus`

描述： 设置传感器使能状态

输入参数：

参数名	类型	描述
`SensorName`	`String`	传感器的名称
`Status`	`String`	使能状态(enabled,disabled)

`ExportSel`

描述： 导出传感器事件列表

输入参数：

参数名	类型	描述
`Path`	`String`	导出sel的路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	Task标识,用于拼接任务路径

`GetSel`

描述： 获取传感器事件列表

输入参数：

参数名	类型	描述
`StartId`	`U16`	事件索引
`Count`	`U16`	事件条数

输出参数：

参数名	类型	描述
`Total`	`U16`	事件总条数
`SelList`	`Array`	事件列表

`GetDiscreteSensorList`

描述： 查询离散传感器列表

输出参数：

参数名	类型	描述
`SensorList`	`Array`	离散传感器列表

`GetReportedSel`

描述： 获取上报事件

输入参数：

参数名	类型	描述
`StartId`	`U64`	事件起始序列号
`Count`	`U16`	事件条数

输出参数：

参数名	类型	描述
`Total`	`U16`	事件总条数
`SelList`	`Array`	事件列表

`DumpSDR`

描述： 将SDR数据dump为二进制文件

输入参数：

参数名	类型	描述
`DumpMode`	`String`	SDR数据缓存模式，限定为 LAN/BT 两种模式

`AddOemSel`

输入参数：

参数名	类型	描述
`RecordType`	`U8`	表征当前要添加的OEM SEL的类型
`Timestamp`	`U32`	表征当前SEL发生的时间
`ManufactureID`	`U32`	表征当前SEL记录的厂商
`SELDatas`	`String`	表征当前SEL记录的数据

输出参数：

参数名	类型	描述
`RecordId`	`U32`	当前OEM SEL数据记录id

`ClearSel`

描述： 清空传感器事件

自定义类型

AllSensorItem 结构：

字段名	类型	描述
SensorNumber	U16
SensorName	String
SensorUnit	String
SensorStatus	String
SensorReading	String
LowerFatal	String
LowerCritical	String
LowerNonCritical	String
UpperNonCritical	String
UpperCritical	String
UpperFatal	String
PosHysteresis	String
NegHysteresis	String
SensorType	U8
BaseUnit	U8
ReadingType	U8
SystemId	U8

ThresholdSensorItem 结构：

字段名	类型	描述
SensorNumber	U16
SensorName	String
SensorIdentifier	String
SensorUnit	String
SensorStatus	String
SensorReading	String
LowerThresholdFatal	String
LowerThresholdCritical	String
LowerThresholdNonCritical	String
UpperThresholdNonCritical	String
UpperThresholdCritical	String
UpperThresholdFatal	String
SensorType	U8
Status	String
Health	String
SystemId	U8

SelInfo 结构：

字段名	类型	描述
MappingTable	Array	Sel信息键值表,键的值包括:序号, 时间戳, 传感器名称, 传感器类型, 传感器事件级别, 传感器事件状态, 传感器事件描述

KeyValueTable 结构：

字段名	类型	描述
Key	String
Value	String

DiscreteSensorItem 结构：

字段名	类型	描述
SensorNumber	U16
SensorName	String
SensorIdentifier	String
SensorStatus	String
SystemId	U8

bmc.kepler.Chassis.SuperPodLabel

属性

属性名	类型	可读写	信号通知	描述
`SuperPodId`	`U32`	只读	变更广播	超节点集合Id,默认值4294967295
`ServerIndex`	`U16`	只读	变更广播	超节点内的计算节点Id编号,默认值65535
`SuperPodSize`	`U16`	只读	变更广播	超节点规模(npu卡的数),默认值384

方法

`SetSuperPodId`

描述： 设置超节点ID

输入参数：

参数名	类型	描述
`SuperPodId`	`U32`	超节点ID

输出参数：

参数名	类型	描述
`Result`	`Boolean`	操作成功或失败

`SetServerIndex`

描述： 设置超节点服务器编号

输入参数：

参数名	类型	描述
`ServerIndex`	`U16`	服务器编号

输出参数：

参数名	类型	描述
`Result`	`Boolean`	操作成功或失败

`SetSuperPodSize`

描述： 设置超节点容量

输入参数：

参数名	类型	描述
`SuperPodSize`	`U16`	超节点容量

输出参数：

参数名	类型	描述
`Result`	`Boolean`	操作成功或失败

`RestoreDefaults`

描述： 恢复超节点属性默认值

输出参数：

参数名	类型	描述
`Result`	`Boolean`	操作成功或失败

bmc.kepler.Chassis.Valve

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	关断阀Id
`Slot`	`U8`	只读	变更广播	关断阀槽位
`Presence`	`U8`	只读	变更广播	关断阀在位。1在位，0不在位
`OpeningDegree`	`U32`	读写	变更广播	关断阀开度
`StandardOpeningDegree`	`U32`	只读	变更广播	关断阀标称开度
`Status`	`U16`	只读	变更广播	关断阀故障状态: 0-正常, 非0-关断阀故障
`OpeningDegreeState`	`U8`	只读	变更广播	关断阀开度状态:0-正常, 1-异常
`PatrolResult`	`U8`	只读	变更广播	关断阀巡检结果: 0-成功, 1-失败

bmc.kepler.Chassis.Valves

属性

属性名	类型	可读写	信号通知	描述
`PatrolState`	`String`	只读	变更广播	巡检状态
`LastPatrolTimestamp`	`U32`	只读	变更广播	最近一次巡检时间

方法

`StartPatrol`

描述： 启动关断阀巡检

输入参数：

参数名	类型	描述
`DelaySeconds`	`U32`	巡检开始等待时间（秒）

bmc.kepler.Chip

属性

属性名	类型	可读写	信号通知	描述
`HealthStatus`	`U8`	只读	变更广播	硬件的健康状态
`PowerStatus`	`U8`	只读	变更广播	硬件的上电状态
`SelfTestResult`	`U8`	只读	变更广播	硬件的自检结果
`LockStatus`	`U8`	只读	变更广播	硬件通道锁定状态，0表示未锁定，1表示锁定

方法

`SetAccessibility`

描述： 设置芯片可访问状态: true:使能访问芯片， false:禁止访问芯片，禁止时长，单位: 秒，取值范围: [1, 1800]

输入参数：

参数名	类型	描述
`Status`	`Boolean`	Status == true -> Allow Chip access; Status == false -> Prohibit Chip access.
`DisableDuration`	`U16`	This parameter only takes effect when status is true.range:[1,1800];Unit:seconds.When duration ends, open Chip access automatically

`SetLockStatus`

描述： 设置芯片锁定状态，optype为1，表示加锁，0表示解释

输入参数：

参数名	类型	描述
`OpType`	`U8`	0表示解锁，1表示加锁
`LockTime`	`U32`	锁定时长，单位为秒，OpType为1时生效，范围：LockTime <= 30min，同APP同器件支持续锁

输出参数：

参数名	类型	描述
`ResultCode`	`Enum`	OpType为1时：OK、RequestorMismatchedError（已锁定状态下，请求发起者与锁定者不一致）、InvalidParameter（LockTime范围错误）、ChipMismatchedError（同通道不同的器件锁定了总线）、ChannelMismatchedError（同总线不同通道的器件锁定了总线），OpType为0时：OK、RequestorMismatchedError（已锁定状态下，请求发起者与锁定者不一致）、UnlockedError（通道未锁定）、ChipMismatchedError（同通道的不同的器件锁定了总线）、ChannelMismatchedError（不同通道的器件锁定了总线）

自定义类型

SetLockStatusResultCode 枚举：

字段名	类型	数值
OK	Enum	0
InvalidParameter	Enum	1
UnlockedError	Enum	2
RequestorMismatchedError	Enum	3
ChipMismatchedError	Enum	4
ChannelMismatchedError	Enum	5

bmc.kepler.Chip.Aggregate

属性

属性名	类型	可读写	信号通知	描述
`Supported`	`Boolean`	只读	变更广播	Chip是否具备汇聚数据访问能力, true: 具备能力, false: 默认值, 不具备能力
`BaseOffset`	`U32`	只读	变更广播	汇聚资源起始偏移/汇聚命令字, Smc场景下为汇聚命令字; 其他块设备场景为起始偏移, 连续读取一段数据
`Length`	`U32`	只读	变更广播	汇聚资源总长度
`Period`	`U32`	只读	变更广播	汇聚资源扫描间隔(单位ms)

bmc.kepler.Chip.BitIO

方法

`Read`

描述： 按位读：将从硬件读取数据与掩码进行按位与操作后返回结果

输入参数：

参数名	类型	描述
`Offset`	`U32`	读取的offset，偏移位置
`Length`	`U8`	读取长度
`Mask`	`U32`	掩码: 用于与从硬件读取的内容进行按位与操作

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	读取的返回结果

`Write`

描述： 按位写：将indata内容与掩码进行按位与修改后写入芯片的offset位置

输入参数：

参数名	类型	描述
`Offset`	`U32`	写入的offset，偏移位置
`Length`	`U8`	写入长度
`Mask`	`U32`	写入掩码: 写入时先获取值，再按位修改后写入到硬件
`InData`	`U8[]`	写入的数据内容

bmc.kepler.Chip.BlockIO

方法

`Read`

描述： 按字节读取从芯片的offset偏移位置读取指定长度内容

输入参数：

参数名	类型	描述
`Offset`	`U32`	读取的offset，偏移位置
`Length`	`U32`	读取长度

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	读取的结果

`Write`

描述： 按字节将指定内容写入芯片的offset偏移位置

输入参数：

参数名	类型	描述
`Offset`	`U32`	写入的offset，偏移位置
`InData`	`U8[]`	写入的数据内容

`WriteRead`

描述： 往固定的offset偏移写入请求数据，再从固定的offset读取指定长度内容

输入参数：

参数名	类型	描述
`InData`	`U8[]`	写入的数据内容
`ReadLength`	`U32`	读取的长度

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	从offset是0xffffffff读取到的内容

`ComboWriteRead`

描述： 先往writeoffset偏移写入请求数据，再从readoffset读取指定长度内容

输入参数：

参数名	类型	描述
`WriteOffset`	`U32`	写入的offset，偏移位置
`InData`	`U8[]`	写入的数据内容
`ReadOffset`	`U32`	读取的offset，偏移位置
`ReadLength`	`U32`	读取长度

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	读取的结果

`BatchWrite`

描述： 批量写入：将不同offset偏移位置的数据，一次性写入对应的chip中

输入参数：

参数名	类型	描述
`WriteData`	`Array`	写入数据：[[offset1,data1], [offset2,data2]]

`PluginRequest`

描述： 功能: 插件访问在hwproxy将代码进行加载后通过chip访问硬件；在插件中访问时将占据总线访问通道，不会切换至其他任务

输入参数：

参数名	类型	描述
`PluginName`	`String`	插件名称
`Cmd`	`String`	命令名称，插件中已实现的函数，hwproxy加载后进行调用并将chip作为第一个参数传入
`Params`	`U8[]`	插件执行函数输入的参数

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	插件执行函数的响应结果

`PluginRequestEx`

描述： 拓展插件请求，支持通过插件访问时对插件能力进行拓展配置

输入参数：

参数名	类型	描述
`PluginName`	`String`	插件名称
`Cmd`	`String`	命令名称，插件中已实现的函数，hwproxy加载后进行调用并将chip作为第一个参数传入
`Params`	`U8[]`	插件执行函数输入的参数
`ControlParams`	`PluginControlParams`	插件能力参数，用以对插件请求拓展能力进行配置。当前支持，控制插件执行优先级：Priority，取值包括高优先级High和次优先级Secondary

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	插件执行函数的响应结果

`WriteReadByProtocol`

描述： 通过指定物理介质和协议的方式对设备进行写入和读取访问

输入参数：

参数名	类型	描述
`InData`	`U8[]`	写入的数据内容
`ReadLength`	`U32`	读取的长度
`Protocol`	`U8`	物理介质和协议类型, 当前仅支持0x02 SMBus/I2c

输出参数：

参数名	类型	描述
`OutData`	`U8[]`	读取的数据内容

自定义类型

SingleWriteData 结构：

字段名	类型	描述
Offset	U32
InData	U8[]

PluginControlParams 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Chip.JtagTarget

方法

`GetChipIdcode`

描述： 用于获取Jtag链上所有器件的IDCODE

输出参数：

参数名	类型	描述
`DeviceId`	`U32[]`	Jtag链上所有器件的IDCODE

`SetTargetNumber`

描述： 选择Bypass模式下在JTAG链中的需要升级的器件

输入参数：

参数名	类型	描述
`Num`	`U32`	芯片的IDCODE

`SetBypassMode`

描述： 用于设置是否使用Bypass模式升级(链上除目标器件外其他器件设置为Bypass)

输入参数：

参数名	类型	描述
`Enable`	`Boolean`	设置是否使用Bypass模式升级的参数

`BypassChannelTest`

描述： 进行jtag链路测试

输入参数：

参数名	类型	描述
`Id`	`U8`	cpld的id, 设备号
`Channel`	`U8`	通道号, Jtag的通道号

输出参数：

参数名	类型	描述
`ResultCode`	`Boolean`	为true代表测试成功，为false代表测试失败

bmc.kepler.Chip.Rtc

属性

属性名	类型	可读写	信号通知	描述
`RtcTimestamp`	`U8[]`	只读	变更广播	Rtc时间戳

bmc.kepler.CmdInfo

属性

属性名	类型	可读写	信号通知	描述
`Filter`	`String`	只读	变更广播	用于匹配IPMI命令数据，生成路由表
`Privilege`	`S16`	只读	变更广播	IPMI命令的访问权限
`Priority`	`S16`	只读	变更广播	命令优先级，当存在相同命令时，选择优先级高的执行
`Cmd`	`U8`	只读	变更广播	IPMI命令字
`ServiceName`	`String`	只读	变更广播	命令对应的服务名
`NetFn`	`U8`	只读	变更广播	IPMI网络字节功能码
`SysLockedPolicy`	`String`	只读	变更广播	系统锁定属性
`Sensitive`	`Boolean`	只读	变更广播	ipmi命令是否包含敏感信息

方法

`Process`

描述： 处理IPMI请求，并返回响应

输入参数：

参数名	类型	描述
`Data`	`U8[]`	请求数据
`Context`	`U8[]`	请求上下文的json字符串，包括通道类型、会话信息、客户端信息

输出参数：

参数名	类型	描述
`Response`	`U8[]`	响应数据

bmc.kepler.Connector

属性

属性名	类型	可读写	信号通知	描述
`Bom`	`String`	只读	变更广播	Bom号
`Slot`	`U8`	读写	变更广播	信号槽
`GroupId`	`U32`	只读	变更广播	对象组ID
`GroupPosition`	`String`	只读	变更广播	对象组位置
`Presence`	`U8`	读写	变更广播	Connector的在位状态
`Id`	`String`	读写	变更广播	Connector的ID
`AuxId`	`String`	读写	变更广播	Connector的AuxID
`Buses`	`String[]`	只读	变更广播	Connector的总线
`SystemId`	`U8`	只读	变更广播	Connector的SystemId
`ManagerId`	`String`	只读	变更广播	Connector的ManagerId
`SilkText`	`String`	只读	变更广播
`Type`	`String`	只读	变更广播	Connector的类型
`IdentifyMode`	`U8`	只读	变更广播	Connector的标志模式
`ChassisId`	`String`	只读	变更广播	Connector的ChassisId
`LoadStatus`	`U8`	只读	变更广播	Connector的加载状态

bmc.kepler.Debug.BlackBox

方法

`DumpPsuBlackbox`

描述： 收集电源黑匣子日志，异步则通过TaskId返回结果

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务Id

bmc.kepler.Debug.DataAcquisitionService

方法

`SetConfigurations`

描述： 数据采集组件参数配置项

输入参数：

参数名	类型	描述
`CfgType`	`String`	选择的配置类型(如：TestIODeterioration:使用导入的json文件触发慢盘检测、TestEstimatedLifespan:使用导入的json文件模拟获取硬盘参数触发预估寿命检测流程等)，为调试命令，仅在调试时使用
`CfgValue`	`String`	设置配置信息（如：json文件路径），为调试命令，仅在调试时使用

输出参数：

参数名	类型	描述
`Result`	`S32`	配置信息设置结果，为调试命令，仅在调试时使用，0:设置成功 -1:设置失败

bmc.kepler.Debug.DiskFaultPrediction

方法

`ExecuteRealDiskInference`

描述： 触发执行一次环境真实硬盘预测推理

输入参数：

参数名	类型	描述
`DataSource`	`U8`	硬盘数据来源，0表示数据库获取，1表示手工构造输入
`SlotNumber`	`U8`	硬盘槽位号

输出参数：

参数名	类型	描述
`PredictResult`	`String[]`	硬盘故障预测结果

`ExecuteFakeDiskInference`

描述： 触发执行一次打桩硬盘预测推理

输入参数：

参数名	类型	描述
`DataSource`	`U8`	指定的数据库数据
`Taghash`	`String`	taghash值
`DiskInfo`	`String[]`	硬盘信息

输出参数：

参数名	类型	描述
`PredictResult`	`String[]`	硬盘故障预测结果

`GetLatestInferenceResult`

描述： 获取最近一次的预测结果

输出参数：

参数名	类型	描述
`LatestPredictionTime`	`String`	最近一次的预测时间
`DfpResult`	`String[]`	最近一次的预测结果

bmc.kepler.Debug.IpmiCore.TraceIpmi

属性

属性名	类型	可读写	信号通知	描述
`EnableTrace`	`Boolean`	只读	变更广播	跟踪IPMI命令收发状态的使能开关
`Channel`	`String`	只读	变更广播	协议通道,支持bt,ipmb,ipmbeth,edma通道
`Netfn`	`U8`	只读	变更广播	网络功能码
`Cmd`	`U8`	只读	变更广播	命令字
`Filter`	`String`	只读	变更广播	预留字段，用于过滤命令
`LogType`	`String`	只读	变更广播	日志类型,file和local两种方式,file表示将结果写入文件,local方式表示将结果直接打印到屏幕

方法

`Trace`

描述： 南向追踪接口

输入参数：

参数名	类型	描述
`EnableTrace`	`Boolean`	南向追踪使能状态
`Channel`	`String`	南向追踪的通道
`Netfn`	`U8`	南向追踪的IPMI网络字节功能码
`Cmd`	`U8`	南向追踪的IPMI命令字
`Filter`	`String`	南向追踪的IPMI过滤字段
`LogType`	`String`	南向追踪的记录方式

bmc.kepler.Debug.LanSwitchMock

方法

`RegRead`

描述： 读取交换板寄存器值

输入参数：

参数名	类型	描述
`Unit`	`U8`	交换板芯片Id
`Type`	`U8`	交换板器件类型：Chip、Phy
`Port`	`U8`	交换板端口号
`Addr`	`U32`	交换板寄存器地址

输出参数：

参数名	类型	描述
`Value`	`U32`	交换板寄存器的值

`RegWrite`

描述： 设置交换板寄存器的值

输入参数：

参数名	类型	描述
`Unit`	`U8`	交换板芯片Id
`Type`	`U8`	交换板器件类型：Chip、Phy
`Port`	`U8`	交换板端口号
`Addr`	`U32`	交换板寄存器地址
`Value`	`U32`	交换板寄存器的值

`GetPortInfo`

描述： 查询交换板端口的信息（端口速率、端口连接状态等）

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`Port`	`U32`	交换板端口号

输出参数：

参数名	类型	描述
`Value`	`String`	交换板端口的信息（端口速率、端口连接状态等）

`SetPortEnable`

描述： 设置交换板端口开关状态

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`Port`	`U32`	交换板端口号
`Enable`	`U32`	交换板端口开关

`SetPortStpState`

描述： 设置交换板端口的STP状态

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`Port`	`U32`	交换板端口号
`State`	`U32`	交换板端口的STP状态

`GetSwitchErrorCode`

描述： 获取交换板utp端口误码

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`UtpNum`	`U32`	交换板utp端口号

输出参数：

参数名	类型	描述
`Value`	`U32`	交换板utp端口误码

`SetPortMacAddr`

描述： 设置交换板端口静态MAC地址

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`Port`	`U32`	交换板端口号
`MacStr`	`String`	交换板端口静态MAC地址

`FlushPortAddr`

描述： 清空交换板端口静态MAC地址

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id
`Port`	`U32`	交换板端口号

`GetVlanInfo`

描述： 获取交换板的vlan信息

输入参数：

参数名	类型	描述
`Unit`	`U32`	交换板芯片Id

输出参数：

参数名	类型	描述
`Value`	`String`	交换板的vlan信息

bmc.kepler.Debug.LogMock

方法

`MockLog`

描述： 模拟日志注入

输入参数：

参数名	类型	描述
`Count`	`U32`	注入的日志数量
`Text`	`String`	注入的日志内容
`RepeatText`	`Boolean`	标志是否重复内容

bmc.kepler.Debug.Managers.NandFlashMock

属性

属性名	类型	可读写	信号通知	描述
`LifeTime`	`U8`	只读	变更广播	调试模式下flash使用的寿命,百分比
`PreEOL`	`U8`	只读	变更广播	调试模式下预留块状态
`DelayTime`	`U32`	只读	变更广播	调试模式下计算使用寿命及使用块的间隔时间，单位秒
`TimeInterval`	`U32`	只读	变更广播	调试模式下写入量统计时间间隔，单位秒
`WriteThreshold`	`U64`	只读	变更广播	调试模式下写入量的阈值，单位字节
`ClearStatisticsInterval`	`U32`	只读	变更广播	调试模式下重置写入量的时间间隔，单位秒
`Enabled`	`Boolean`	读写	变更广播	开启关闭调试模式
`SamplingPeriodSeconds`	`U32`	读写	变更广播	扫描周期,单位秒

方法

`SetDebugValue`

描述： 调试模式下设置参数

输入参数：

参数名	类型	描述
`LifeTime`	`U8`	调试模式下flash使用的寿命,百分比
`PreEOL`	`U8`	调试模式下预留块状态
`DelayTime`	`U32`	调试模式下计算使用寿命及使用块的间隔时间，单位秒
`TimeInterval`	`U32`	调试模式下写入量统计时间间隔，单位秒
`WriteThreshold`	`U64`	调试模式下写入量的阈值，单位字节
`ClearStatisticsInterval`	`U32`	调试模式下重置写入量的时间间隔，单位秒

bmc.kepler.Debug.Mctp

方法

`SetTransmissionUnitSize`

输入参数：

参数名	类型	描述
`Size`	`U16`	MCtp传输单元大小

bmc.kepler.Debug.Mock

方法

`MockScannerFailure`

描述： 模拟Scanner故障接口，ScannerName:模拟故障的Scanner名称，FailureDuration:故障持续时间(范围：1s<= FailureDuration <= 1800s)

输入参数：

参数名	类型	描述
`ScannerName`	`String`	模拟故障的Scanner名称
`FailureDuration`	`U32`	故障持续时间,单位(s),范围: 1s <= FailureDuration <= 1800s

`MockBusCtrl`

描述： 模拟控制总线挂死与恢复,BusName:模拟总线的名称，Action：模拟动作（suspend:挂死，resume:恢复）

输入参数：

参数名	类型	描述
`BusName`	`String`	控制的Bus服务名称
`Action`	`String`	控制动作, suspend: 模拟总线挂死, resume: 模拟总线恢复

bmc.kepler.Debug.Performance

属性

属性名	类型	可读写	信号通知	描述
`PerformanceSamplingIntervalMinutes`	`U16`	读写	变更广播	性能数据采集周期，单位：分钟

bmc.kepler.Debug.Performance.Metrics

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	使能性能统计

方法

`Report`

描述： 导出性能报表数据（导出到/tmp目录下）

bmc.kepler.Debug.Storage.PhyBitError

属性

属性名	类型	可读写	信号通知	描述
`FileMockEnabled`	`Boolean`	读写	变更广播	PHY误码模拟文件使能

方法

`MockData`

描述： 模拟Phy误码数据

输入参数：

参数名	类型	描述
`ControllerId`	`U8`	控制器Id
`ExpanderId`	`U8`	Expander的Id
`FilePath`	`String`	误码数据文件存放路径

输出参数：

参数名	类型	描述
`MockResult`	`U8`	模拟结果

bmc.kepler.Debug.Storage.RecordDriveSpareBlock

方法

`MockRecordSpareBlock`

描述： 模拟硬盘冗余块数据

输入参数：

参数名	类型	描述
`Id`	`U8`	硬盘Id
`SlcSpareBlock`	`U8`	非用户区冗余块数据
`TlcSpareBlock`	`U8`	用户区冗余块数据

bmc.kepler.Debug.Systems.ExceptionInfo

方法

`SetStateMachine`

描述： 调试命令：设置诊断状态机参数，用于调试触发各种诊断流程

输入参数：

参数名	类型	描述
`Parm`	`U8[]`	诊断状态机参数

输出参数：

参数名	类型	描述
`Ret`	`S32`	设置结果，-1:设置失败 0:设置成功
`ErrorInfo`	`String`	错误信息

`SetExceptionStatus`

描述： 调试命令：设置整机系统异常状态，用于测试多种系统异常信号记录

输入参数：

参数名	类型	描述
`SysStatus`	`U32`	XPU状态（如：CPU、NPU）
`ProcessorsStatus`	`U64`	所有处理器状态

输出参数：

参数名	类型	描述
`SysStatus`	`U32`	XPU状态（如：CPU、NPU）
`ProcessorsStatus`	`U64`	所有处理器状态

bmc.kepler.Debug.Systems.FDMDomain

方法

`GetConfigurations`

描述： 调试命令：获取当前子系统下的fdm辅助配置信息

输入参数：

参数名	类型	描述
`CfgType`	`String`	选择的配置类型(如：MemRASResource:获取内存隔离资源、HbmPageOffline:获取HBM PageOffline隔离资源等)，为调试命令，仅在调试时使用

输出参数：

参数名	类型	描述
`CfgData`	`String`	返回的配置信息，为调试命令，仅在调试时使用

`SetConfigurations`

描述： 调试命令：设置当前系统下的fdm辅助配置信息

输入参数：

参数名	类型	描述
`CfgType`	`String`	选择的配置类型（如：HbmPageofflineResource:设置HBM PageOffline隔离资源数量、SetFdmLogLimitingEnable:设置imu日志限流开关等），为调试命令，仅在调试时使用
`CfgValue`	`String`	设置配置信息（如：HBM PageOffline隔离资源数量、限流开关等），为调试命令，仅在调试时使用

输出参数：

参数名	类型	描述
`Result`	`U32`	配置信息设置结果，为调试命令，仅在调试时使用，0:设置成功 -1:设置失败

`SysAddr2DdrAddr`

描述： 将系统地址转换为物理内存地址

输入参数：

参数名	类型	描述
`SystemAddress`	`U64`	系统地址

输出参数：

参数名	类型	描述
`DdrAddress`	`String`	物理内存地址

`SysAddr2HbmAddr`

描述： 将系统地址转换为HBM物理地址

输入参数：

参数名	类型	描述
`SystemAddress`	`U64`	系统地址

输出参数：

参数名	类型	描述
`DdrAddress`	`String`	HBM物理地址

`DdrAddr2SysAddr`

描述： 将物理内存地址转换为系统地址

输入参数：

参数名	类型	描述
`DdrAddress`	`String`	物理内存地址

输出参数：

参数名	类型	描述
`SystemAddress`	`U64`	系统地址

`MemoryIsolation`

描述： 向IMU请求故障内存隔离，并等待返回结果

输入参数：

参数名	类型	描述
`IsolationType`	`String`	隔离类型，0:ACLS 1:SPPR 2:HPPR 3:ADDDC 4:SDDC 5:RankSparing 6:PageOffline
`DdrAddress`	`String`	待隔离的物理内存地址

输出参数：

参数名	类型	描述
`Result`	`U32`	隔离结果

bmc.kepler.Debug.Systems.FDMDomain.BoardRAS

方法

`DumpBoardLog`

描述： 获取天池组件flash中的日志，目前仅存在BCU导出在/tmp目录下，需要判断是否为软链接

输入参数：

参数名	类型	描述
`SystemId`	`U8`	系统Id

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Debug.Systems.NCSI

方法

`SendCmdOverMCTP`

描述： 调试NCSIoverMCTP命令接口

输入参数：

参数名	类型	描述
`NodeId`	`String`	网口的NodeId作为主件的唯一标识
`Command`	`U8`	MCTP命令packet_type
`Payload`	`String`	命令传入的数据

输出参数：

参数名	类型	描述
`Data`	`String`	命令返回数据

bmc.kepler.Dft

方法

`MockLogStorm`

描述： 模拟日志风暴的接口

输入参数：

参数名	类型	描述
`Count`	`U32`	风暴日志的次数

bmc.kepler.EepromData

属性

属性名	类型	可读写	信号通知	描述
`CSRVersion`	`String`	读写	变更广播	Eeprom里csr的版本号

bmc.kepler.EventService

属性

属性名	类型	可读写	信号通知	描述
`ServiceEnabled`	`Boolean`	读写	变更广播	Https上报事件是否使能,默认值:true
`DeliveryRetryAttempts`	`U8`	读写	变更广播	事件订阅发送失败最大尝试次数,默认值:3
`DeliveryRetryIntervalSeconds`	`U32`	读写	变更广播	发送任何给定事件的重试尝试之间的秒数,默认值:60
`ServerIdentitySource`	`String`	读写	变更广播	主机标识,枚举类型
`ShieldResources`	`String`	读写	变更广播	屏蔽事件上报的资源属性

方法

`SubmitTestEvent`

描述： 模拟测试事件方法

输入参数：

参数名	类型	描述
`EventType`	`String`	模拟事件类型
`EventId`	`String`	模拟事件对应的事件码
`EventTimestamp`	`String`	模拟事件的时间戳
`Severity`	`String`	模拟事件严重等级
`Message`	`String`	模拟事件消息
`MessageId`	`String`	模拟事件消息Id
`MessageArgs`	`String[]`	模拟事件消息格式化参数
`OriginOfCondition`	`String`	模拟事件关联的事件源列表

`Rearm`

描述： 对未恢复的redfish告警事件重新上报

bmc.kepler.EventService.Event

方法

`Rearm`

描述： 重新上报未恢复的所有级别的告警事件给指定的网管

输入参数：

参数名	类型	描述
`SubscriptionType`	`String[]`	上报的网管类型: All、RedfishEvent、Syslog、SNMPTrap、Smtp

bmc.kepler.EventService.Subscriptions

方法

`CreateDestination`

描述： 创建订阅方法

输入参数：

参数名	类型	描述
`DestinationValues`	`DestinationValues`

输出参数：

参数名	类型	描述
`Id`	`U8`	事件订阅资源的标识

自定义类型

DestinationValues 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.EventService.Subscriptions.Destination

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	订阅者资源Id
`Destination`	`String`	只读	变更广播	事件订阅接收地址
`EventTypes`	`String[]`	只读	变更广播	事件订阅侦听的事件类型
`MessageIds`	`String[]`	只读	变更广播	事件订阅消息Id匹配列表
`OriginResources`	`String`	只读	变更广播	事件订阅事件源匹配列表
`Context`	`String`	读写	变更广播	事件订阅上下文信息
`Protocol`	`String`	只读	变更广播	事件订阅使用的协议,当前取值只能为Redfish
`SendHeartbeat`	`Boolean`	只读	变更广播	告警心跳使能
`HeartbeatIntervalMinutes`	`U16`	只读	变更广播	告警心跳间隔,取值范围[1:65535]
`MetricReportDefinitions`	`String[]`	只读	变更广播	指定事件订阅上报的Metric Report列表
`State`	`String`	读写	变更广播	redfish上报的订阅状态
`DeliveryRetryPolicy`	`String`	读写	变更广播	redfish上报的重试策略,如果用户空字符串，则认为指定了默认值

方法

`SetHttpHeaders`

描述： 设置http请求头（加密存储）

输入参数：

参数名	类型	描述
`Headers`	`String`	http请求头

`Delete`

描述： 删除时间订阅资源

`ResumeSubscription`

描述： 恢复当前时间到之前一段时间内缓存的上报事件，如果传入参数为空，则恢复所有事件

输入参数：

参数名	类型	描述
`DeliverBufferedEventDuration`	`String`	指定恢复的事件，若不为空则需要符合ISO-9601规范的字符串

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

`SuspendSubscription`

描述： 暂停redfish事件消息发送

bmc.kepler.EventService.Subscriptions.Redfish

属性

属性名	类型	可读写	信号通知	描述
`AlertLanguage`	`String`	读写	变更广播	上报事件的语言
`EventType`	`String`	只读	变更广播	用于Redfish通道事件上报的类型

bmc.kepler.EventService.Subscriptions.Smtp

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	SMTP上报事件是否使能
`Address`	`String`	读写	变更广播	SMTP服务器的地址
`Port`	`U16`	读写	变更广播	SMTP服务器端口号
`TLSEnabled`	`Boolean`	读写	变更广播	TLS加密是否使能
`ServerAuthEnabled`	`Boolean`	读写	变更广播	SMTP服务器的身份认证是否使能(单向认证是否使能)
`SeverityFilter`	`U8`	读写	变更广播	告警上报的级别,只有对应Bit位为1的级别才会上报
`EventType`	`String`	读写	变更广播	用于Smtp通道事件上报的类型

方法

`SetAddress`

描述： 设置SMTP服务器地址，非匿名时需要重置发件人密码

输入参数：

参数名	类型	描述
`Address`	`String`	SMTP服务器地址
`PasswordChanged`	`Boolean`	用户是否重置密码

bmc.kepler.EventService.Subscriptions.Smtp.Email

属性

属性名	类型	可读写	信号通知	描述
`AnonymousEnabled`	`Boolean`	读写	变更广播	邮件匿名发送是否使能
`EmailSubject`	`String`	读写	变更广播	邮件主题
`EmailSubjectContains`	`String[]`	读写	变更广播	邮件主题携带的信息，更方便于错误引擎、权限校验和拓展

方法

`SetAnonymousState`

描述： 设置匿名使能状态,把匿名状态从匿名改为非匿名时,需要重置发件人密码

输入参数：

参数名	类型	描述
`State`	`Boolean`	匿名使能状态
`PasswordChanged`	`Boolean`	用户是否重置密码

bmc.kepler.EventService.Subscriptions.Smtp.Receiver

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	告警收件人是否使能
`ToAddress`	`String`	读写	变更广播	告警收件人的邮箱地址
`Description`	`String`	读写	变更广播	告警收件人的描述信息

方法

`SubmitTestEvent`

描述： 测试告警收件人邮箱地址的有效性

bmc.kepler.EventService.Subscriptions.Smtp.Sender

属性

属性名	类型	可读写	信号通知	描述
`Username`	`String`	读写	变更广播	发件人用户名
`FromAddress`	`String`	读写	变更广播	发件人邮箱地址

方法

`SetUsername`

描述： 设置发件人的用户名，非匿名时需要重置发件人密码

输入参数：

参数名	类型	描述
`Username`	`String`	发件人的用户名
`PasswordChanged`	`Boolean`	用户是否重置密码

`SetPassword`

描述： 设置发件人用户密码

输入参数：

参数名	类型	描述
`Password`	`String`	发件人用户密码

bmc.kepler.EventService.Subscriptions.Snmp

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	SNMP上报告警事件是否使能
`Version`	`String`	读写	变更广播	SNMP版本,取值:SNMPv1,SNMPv2c,SNMPv3
`SeverityFilter`	`U8`	读写	变更广播	告警上报的级别,只有对应Bit位为1的级别才会上报
`ServerIdentity`	`String`	读写	变更广播	主机标识:单板序列号BoardSN、产品资产标签ProductAssetTag、主机名HostName
`EventType`	`String`	读写	变更广播	用于Snmp通道事件上报的类型

方法

`SetCommunity`

描述： 设置SNMP上报告警事件的团体名

输入参数：

参数名	类型	描述
`Community`	`String`	SNMP上报告警事件的团体名

`GetCommunity`

描述： 获取SNMP trap v1v2上报告警事件的团体名

输出参数：

参数名	类型	描述
`Community`	`String`	SNMP trap v1v2上报告警事件的团体名

bmc.kepler.EventService.Subscriptions.Snmp.Nms

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	网络管理系统是否使能
`BobEnabled`	`Boolean`	读写	变更广播	转发到带内BMA是否使能
`Address`	`String`	读写	变更广播	网络管理系统的地址
`Port`	`U16`	读写	变更广播	网络管理系统的端口号

方法

`SubmitTestEvent`

描述： 测试网络管理系统的有效性

bmc.kepler.EventService.Subscriptions.Syslog

属性

属性名	类型	可读写	信号通知	描述
`EventType`	`String`	读写	变更广播	用于Syslog通道事件上报的类型

bmc.kepler.Example.InterfaceBar

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U32`	只读	变更广播	接口ID
`Name`	`String`	只读	变更广播	接口名称
`Presence`	`Boolean`	读写	变更广播	接口在位状态
`Frudata`	`U8[]`	读写	变更广播	fru数据

方法

`MethodBar`

输入参数：

参数名	类型	描述
`StructArg`	`unknown`
`ArrayArg`	`U32[]`
`ArrayStruct`	`Array`

输出参数：

参数名	类型	描述
`Result`	`U32`

自定义类型

SturctArg 结构：

字段名	类型	描述
SubArg1	String
SubArg2	String

bmc.kepler.Example.InterfaceFoo

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	读写	变更广播	接口名称
`Status`	`U32`	只读	变更广播	接口在位状态

方法

`MethodFoo`

输入参数：

参数名	类型	描述
`Arg1`	`U32`

输出参数：

参数名	类型	描述
`Result`	`U32`

bmc.kepler.Example.InterfaceTest

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U32`	只读	变更广播	接口id
`Name`	`String`	读写	变更广播	接口名称
`Presence`	`Boolean`	读写	变更广播	接口在位状态
`Frudata`	`U8[]`	读写	变更广播	接口fru数据
`Struct`	`Struct`	读写	变更广播	接口在位状态
`PropA`	`Dict1`	读写	变更广播	接口属性

方法

`AddObject`

输入参数：

参数名	类型	描述
`Id`	`U32`

`DeleteObject`

输入参数：

参数名	类型	描述
`Id`	`U32`

`MethodA`

输入参数：

参数名	类型	描述
`Request`	`Dict1`

输出参数：

参数名	类型	描述
`Result`	`Dict1`

自定义类型

SturctArg 结构：

字段名	类型	描述
SubArg1	String
SubArg2	U8

Dict1 结构：

字段名	类型	描述
key	String
value	U32

bmc.kepler.FrudataService.Frudata

方法

`Update`

描述： 非标准电子标签更新资源树属性值接口

输入参数：

参数名	类型	描述
`PropertyName`	`String[]`	电子标签属性名数组
`Value`	`String[]`	电子标签属性值数组

`SetSysProductName`

描述： 设置系统产品名称接口

输入参数：

参数名	类型	描述
`FruId`	`U8`	电子标签唯一标识FruId
`ProductName`	`String`	产品名称

`SetProductAssetTag`

描述： 设置产品资产标签

输入参数：

参数名	类型	描述
`FruId`	`U8`	电子标签ID
`AssetTag`	`String`	资产标签

bmc.kepler.InferenceAsync

方法

`InferenceAsync`

描述： site_ai异步推理服务入口，例如硬盘故障预测、内存故障预测等

输入参数：

参数名	类型	描述
`ModelName`	`String`	模型名称
`Dimension`	`U32`	总维度数
`Shape`	`U32[]`	维度信息
`Data`	`Double[]`	特征值

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Inventory.Hardware

属性

属性名	类型	可读写	信号通知	描述
`AssetType`	`String`	只读	变更广播	硬件资产类型
`AssetName`	`String`	只读	变更广播	硬件资产名称
`SerialNumber`	`String`	只读	变更广播	硬件资产序列号
`FirmwareVersion`	`String`	只读	变更广播	硬件资产固件版本
`PCBVersion`	`String`	只读	变更广播	硬件资产PCB版本
`Manufacturer`	`String`	只读	变更广播	硬件资产制造商
`AssetTag`	`String`	只读	变更广播	硬件资产标签
`PartNumber`	`String`	只读	变更广播	硬件资产部件编号
`ManufactureDate`	`String`	只读	变更广播	硬件资产生产日期
`Slot`	`String`	只读	变更广播	硬件槽位号
`UUID`	`String`	只读	变更广播	硬件UUID号

bmc.kepler.IpmiCore

属性

属性名	类型	可读写	信号通知	描述
`Version`	`String`	只读	变更广播	ipmi规范版本,当前默认值2.0
`HostUSBChannelEnabled`	`Boolean`	读写	变更广播	USB设备带内通信ipmi通道使能
`ChannelAccesses`	`Privileges`	只读	变更广播	ipmb/edma/ipmbeth通道权限控制,通道类型取值范围[ICMB、IPMB、SMS]通道权限取值范围[0,2,3,4]分别代表无权限、用户、操作员、管理员

方法

`Request`

描述： IPMI消息的请求接口

输入参数：

参数名	类型	描述
`ChanType`	`U8`	IPMI消息的请求通道类型
`Instance`	`U8`	IPMI消息的请求通道实例
`NetFn`	`U8`	IPMI消息的网络码
`Lun`	`U8`	IPMI消息的Lun号
`Cmd`	`U8`	IPMI消息的命令字
`Payload`	`U8[]`	IPMI消息的请求数据

输出参数：

参数名	类型	描述
`CompletionCode`	`U8`	响应码
`Payload`	`U8[]`	IPMI消息的响应数据

`Route`

描述： 底层通道传送的IPMI消息处理接口

输入参数：

参数名	类型	描述
`Req`	`U8[]`	请求数据
`Ctx`	`U8[]`	请求上下文的json字符串，包括通道类型、会话信息、客户端信息

输出参数：

参数名	类型	描述
`Rsp`	`U8[]`	响应数据

`SetHostPrivilegeLimited`

描述： 设置host侧发送到BMC的ipmi命令权限限制集合

输入参数：

参数名	类型	描述
`SystemId`	`String`	设置权限的host标识
`Privileges`	`String[]`	设置的权限集合，如果是nil或者空表则认为是清空权限集合

输出参数：

参数名	类型	描述
`Ret`	`Boolean`	返回值
`Reason`	`String`	设置权限失败的原因

`SetChannelAccesses`

描述： 根据通道类型设置IPMI通道访问权限

输入参数：

参数名	类型	描述
`ChannelType`	`String`	通道类型
`AccessRole`	`String`	访问角色

自定义类型

Privileges 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.IpmiService.Firewall

属性

属性名	类型	可读写	信号通知	描述
`Mode`	`U8`	读写	变更广播	防火墙黑白名单模式，0xff：关闭；0：黑名单模式；1：白名单模式

方法

`AddItem`

描述： 添加IPMI命令到黑白名单列表

输入参数：

参数名	类型	描述
`Type`	`U8`	当前添加的名单类型，0：黑名单；1：白名单
`RWFlag`	`U8`	当前请求的读写类型，预留位，默认填0
`NetFn`	`U8`	当前添加的IPMI命令的网络码
`Cmd`	`U8`	当前添加的IPMI命令的命令字
`Channel`	`U8`	当前添加的IPMI命令的通道编号
`Datas`	`U8[]`	当前添加的IPMI命令的数据，最长30个字符，字节流编码

`DeleteItem`

描述： 从黑白名单列表删除IPMI命令

输入参数：

参数名	类型	描述
`Type`	`U8`	当前删除的名单类型，0：黑名单；1：白名单
`RWFlag`	`U8`	当前请求的读写类型，预留位，默认填0
`NetFn`	`U8`	当前删除的IPMI命令的网络码
`Cmd`	`U8`	当前删除的IPMI命令的命令字
`Channel`	`U8`	当前删除的IPMI命令的通道编号
`Datas`	`U8[]`	当前删除的IPMI命令的数据，最长30个字符，字节流编码

`Clear`

描述： 清除黑白名单列表

输入参数：

参数名	类型	描述
`Type`	`U8`	当前清除的名单类型，0：黑名单；1：白名单；255：黑名单和白名单

`GetList`

描述： 获取黑白名单列表

输入参数：

参数名	类型	描述
`Type`	`U8`	当前获取的名单类型，0：黑名单；1：白名单

输出参数：

参数名	类型	描述
`BWList`	`Array`	查询到的黑名单或白名单中的IPMI命令数组

自定义类型

BWItem 结构：

字段名	类型	描述
NetFn	U8	IPMI命令的网络码
Cmd	U8	IPMI命令的命令字
Channel	U8	IPMI命令的通道编号
DataLength	U8	IPMI命令的数据长度
Datas	U8[]	IPMI命令的数据

bmc.kepler.JobService

属性

属性名	类型	可读写	信号通知	描述
`DateTime`	`String`	只读	变更广播	JobService服务状态变更时间
`MaxJobs`	`U32`	只读	变更广播	JobService服务支持的最大job数
`Scheduling`	`Boolean`	只读	变更广播	JobService服务是否支持任务编排
`ServiceEnabled`	`Boolean`	读写	变更广播	JobService服务使能状态
`DeleteOnCompletionTimeoutMinutes`	`U32`	只读	变更广播	JobService服务已完成状态job的清理时间

方法

`GetJobTypes`

描述： 获取已支持的Job任务信息

输出参数：

参数名	类型	描述
`Data`	`String[]`	已支持的Job任务信息

bmc.kepler.JobService.Job

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	Job任务的Id
`CreatedBy`	`String`	只读	变更广播	Job任务的创建者
`JobStatus`	`String`	只读	变更广播	Job功能本身的状态
`JobState`	`String`	只读	变更广播	Job任务的状态
`StartTime`	`U32`	只读	变更广播	Job任务开始时间戳
`EndTime`	`U32`	只读	变更广播	Job任务结束时间戳
`PercentComplete`	`U32`	只读	变更广播	Job任务的状态
`Lifetime`	`String`	只读	变更广播	Job任务整体过期时间
`InitialStartTime`	`U32`	只读	变更广播	Job任务最早触发时间戳
`RecurrenceInterval`	`String`	只读	变更广播	最近两次连续执行任务的时间间隔
`EnabledDaysOfWeek`	`String[]`	只读	变更广播	每周的哪一天生效
`MaxOccurrences`	`U32`	只读	变更广播	最大的执行次数
`Name`	`String`	只读	变更广播	Job任务的名称
`HidePayload`	`Boolean`	只读	变更广播	是否隐藏payload的显示
`JsonBody`	`String`	只读	变更广播	Job任务执行的参数
`JobType`	`String`	只读	变更广播	Job任务的类型
`CreateTime`	`U32`	只读	变更广播	Job任务的创建时间戳
`ExecutedTimes`	`U32`	只读	变更广播	Job任务执行的次数
`Origin`	`String`	只读	变更广播	创建任务的接口来源
`Abortable`	`Boolean`	只读	变更广播	Job任务是否可以终止
`MessageArgs`	`String[]`	只读	变更广播	消息涉及的参数
`MessageId`	`String`	只读	变更广播	消息的ID
`Message`	`String`	只读	变更广播	消息的内容

方法

`DeleteJob`

描述： 删除Job

`UpdateJob`

描述： 更新Job

输入参数：

参数名	类型	描述
`Request`	`JobObject`	Job信息键值表,键的值包括:JobState、EnabledDaysOfWeek、InitialStartTime、Lifetime、MaxOccurrences、Name、RecurrenceInterval

自定义类型

JobObject 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.JobService.JobFunction

属性

属性名	类型	可读写	信号通知	描述
`JobType`	`String`	只读	变更广播	注册到JobService的Job的类型
`MaxExecutionTime`	`U32`	只读	变更广播	Job允许的最大执行时间,单位:min
`PayloadParams`	`String`	只读	变更广播	Job执行Run动作需要的入参schema
`Privilege`	`String[]`	只读	变更广播	操作Job需要的权限
`LockdownAllow`	`Boolean`	只读	变更广播	用于系统锁定打开状态下操作是否允许运行Job，值为true代表操作允许，值为false表示不允许
`Abortable`	`Boolean`	只读	变更广播	是否支持运行时终止任务，值为true代表操作允许，值为false表示不允许

方法

`Run`

描述： 执行任务

输入参数：

参数名	类型	描述
`Param`	`String`	Job执行需要的入参

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识
`TaskPath`	`String`	任务对应资源树path路径

`Cancel`

描述： 终止任务

输入参数：

参数名	类型	描述
`TaskId`	`U32`	终止的任务标识

`BeforeCreate`

描述： 用于创建Job之前预处理, 如果抛错则不会创建Job

输入参数：

参数名	类型	描述
`Param`	`String`	创建Job前动作执行需要的入参

bmc.kepler.JobService.Jobs

方法

`CreateJob`

描述： 创建Job

输入参数：

参数名	类型	描述
`Request`	`JobsObject`	Job任务键值表,键的值包括:CreatedBy、EnabledDaysOfWeek、InitialStartTime、Lifetime、MaxOccurrences、Name、RecurrenceInterval、HidePayload、JsonBody、StartTime、JobType

输出参数：

参数名	类型	描述
`Id`	`String`	创建的Job的Id

自定义类型

JobsObject 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.KeyService

属性

属性名	类型	可读写	信号通知	描述
`UpdateInterval`	`U32`	读写	变更广播	密钥更新周期设置
`LastUpdateTime`	`U32`	只读	变更广播	密钥最后更新的时间

方法

`UpdateKey`

描述： 手动触发密钥更新

输出参数：

参数名	类型	描述
`TaskId`	`U32`	异步任务Id

`CiphertextUpdated`

描述： 业务组件通知key_mgmt删除旧密钥

输入参数：

参数名	类型	描述
`DomainId`	`U32`	KMC域Id
`KeyId`	`U32`	需要删除的旧密钥

`GetUpdateState`

描述： 获取密钥更新状态: 0: 未更新密钥 1：密钥正在更新中 2：密钥已经更新（24小时内更新过）

输出参数：

参数名	类型	描述
`State`	`U8`	密钥更新状态: 0: 未更新密钥 1：密钥正在更新中 2：密钥已经更新（24小时内更新过）

bmc.kepler.KeyService.Key

属性

属性名	类型	可读写	信号通知	描述
`DomainId`	`U32`	只读	变更广播	域ID
`KeyId`	`U32`	只读	变更广播	keyID
`KeyType`	`U32`	只读	变更广播	key的类型
`Status`	`U32`	只读	变更广播	key的状态
`GenerateType`	`U32`	只读	变更广播	key的生成状态
`CreateTime`	`U32`	只读	变更广播	key的创建时间
`ExpiredTime`	`U32`	只读	变更广播	key的过期时间
`CiphertextKeyId`	`U32`	只读	变更广播	密文的keyID

bmc.kepler.KeyService.Keys

方法

`RegisterKey`

描述： 组件注册kmc服务，获取domainiD

输入参数：

参数名	类型	描述
`AppName`	`String`	初始化的组件名称
`KsfName`	`String`	组件ksf文件主密钥文件名
`KsfBakName`	`String`	组件ksf文件备密钥文件名
`KsfPath`	`String`	组件主ksf文件路径
`KsfBakPath`	`String`	组件备ksf文件路径
`OwnerId`	`U32`	密钥文件owner，所有者
`GroupId`	`U32`	密钥文件所属的用户组

输出参数：

参数名	类型	描述
`DomainId`	`U32`	KMC域Id

bmc.kepler.LicenseService

属性

属性名	类型	可读写	信号通知	描述
`ESN`	`String`	只读	变更广播	设备序列号,由主板的序列号生成,用于web页面或redfish返回消息中信息呈现
`Capability`	`String[]`	只读	变更广播	表示License组件是否具备本地管理和远程管理的能力,取值为Remote, Local
`ESNState`	`String`	只读	变更广播	产品ESN是否有效,主板序列号和ESN对应时认为ESN有效
`FileState`	`String`	只读	变更广播	LicenseId与对应的文件状态组成的json对象,文件状态取值:Normal, Incorrect

方法

`InstallFromRemote`

输入参数：

参数名	类型	描述
`LicenseFileURI`	`String`
`TransferProtocol`	`String`
`Username`	`String`
`Password`	`String`

`InstallFromLocal`

输入参数：

参数名	类型	描述
`Type`	`String`
`Content`	`String`
`FileSource`	`String`

输出参数：

参数名	类型	描述
`TaskId`	`U32`

`Export`

输入参数：

参数名	类型	描述
`LicenseId`	`String`
`Path`	`String`

输出参数：

参数名	类型	描述
`TaskId`	`U32`

`Delete`

输入参数：

参数名	类型	描述
`LicenseId`	`String`

`Revoke`

输入参数：

参数名	类型	描述
`LicenseId`	`String`

输出参数：

参数名	类型	描述
`RevokeTicket`	`String`

bmc.kepler.LicenseService.Feature

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	授权特性名称
`Status`	`Boolean`	只读	变更广播	授权特性使能状态

bmc.kepler.LicenseService.License

属性

属性名	类型	可读写	信号通知	描述
`Status`	`String`	只读	变更广播	当前License的状态
`RevokeTicket`	`String`	只读	变更广播	当前License失效后的失效码
`RemainGraceDays`	`U32`	只读	变更广播	当前License剩余的宽限期天数
`RemainCommissioningDays`	`U32`	只读	变更广播	当前License剩下的调测天数

方法

`GetContent`

描述： 获取当前License信息，用于web页面或redfish返回消息中呈现

输出参数：

参数名	类型	描述
`Content`	`String`	License信息

bmc.kepler.LifeCycle.Retirement

属性

属性名	类型	可读写	信号通知	描述
`Media`	`String`	只读	变更广播	数据存储介质
`Source`	`String`	只读	变更广播	存储介质来源
`Description`	`String`	只读	变更广播	数据清理描述
`Method`	`String`	只读	变更广播	数据清除方法
`Result`	`String`	只读	变更广播	部件数据销毁结果
`Progress`	`U8`	只读	变更广播	部件数据销毁进度
`State`	`String`	只读	变更广播	部件数据销毁状态

方法

`DataWipe`

描述： 执行部件数据销毁

`GetReport`

描述： 获取部件数据销毁报告

输出参数：

参数名	类型	描述
`Report`	`DataWipeReportDict`

自定义类型

DataWipeReportDict 结构：

字段名	类型	描述
key	String	部件数据销毁报告属性
value	String	部件数据销毁报告值

bmc.kepler.MCAdmin

方法

`GetComponentList`

描述： 框架主程序提供给组件，用于查询当前正在运行的组件列表，返回值是一个string数组

输出参数：

参数名	类型	描述
`OutData`	`String[]`	返回值是一个string数组,表示正在运行的组件列表

`AddMatch`

描述： 在共享内存中添加订阅规则

输入参数：

参数名	类型	描述
`MatchString`	`String`	要添加的订阅规则字符串

`RemoveMatch`

描述： 在共享内存中删除订阅规则

输入参数：

参数名	类型	描述
`MatchString`	`String`	要删除的订阅规则字符串

bmc.kepler.Managers.BMC

属性

属性名	类型	可读写	信号通知	描述
`SoftwareName`	`String`	读写	变更广播	BMC软件名称
`SoftwareType`	`U8`	只读	变更广播	软件类型 0: 机架管理;1: 高密计算节点管理;2: 刀片计算节点管理;3: 交换节点管理, 交换板的管理;4: 机框/柜外围部件管理, MMC/MM/RMC,负责管理电源节点的外围部件，如电源、风扇;5: 机框/柜集中管理, SMM/CMC等, 整框集中管理, 节点信息汇总展示;6: 机柜管理，包括柜内节点设备和柜上外接设备的管理
`PackageName`	`String`	只读	变更广播	BMC Support发布包名称

bmc.kepler.Managers.BlackBox

方法

`DumpData`

描述： 黑匣子数据下载接口

输入参数：

参数名	类型	描述
`Path`	`String`	导出路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Managers.Chassis.NetConfig

属性

属性名	类型	可读写	信号通知	描述
`MasterSmmLinkNetId`	`U8`	只读	变更广播	机框平面主板使用的链路 1：smm1 2：smm2

bmc.kepler.Managers.Configurations

属性

属性名	类型	可读写	信号通知	描述
`FactoryRestorePointTimestamp`	`String`	只读	变更广播	出厂还原点设置时间

方法

`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

`Export`

描述： 配置导出，用于导出配置文件

输入参数：

参数名	类型	描述
`FilePath`	`String`	远程或本地路径
`Type`	`String`	custom: 业务导出; configuration: 定制导出

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务ID

`Set`

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

输入参数：

参数名	类型	描述
`ConfigData`	`String`	配置数据

`Get`

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

输出参数：

参数名	类型	描述
`ConfigData`	`String`	配置数据

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

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.EthernetInterfaces

属性

属性名	类型	可读写	信号通知	描述
`EthName`	`String`	只读	变更广播	网口名称
`NetMode`	`String`	读写	变更广播	网络模式
`Mac`	`String`	只读	变更广播	网口Mac地址
`IpVersion`	`String`	读写	变更广播	IP协议类型,IPv4,IPv6,IPv4AndIPv6
`NcsiEnable`	`Boolean`	只读	变更广播	NCSI使能状态
`PortId`	`U8`	只读	变更广播	当前激活端口
`VLANEnable`	`Boolean`	只读	变更广播	NCSI VLAN使能状态
`VLANId`	`U16`	只读	变更广播	Vlan Id
`SLAACAddressList`	`String[]`	只读	变更广播	SLAAC地址
`LinkLocalAddress`	`String`	只读	变更广播	ipv6本地链路地址
`BackupIpActivated`	`Boolean`	只读	变更广播	备份ip激活状态
`DefaultFactoryIpMode`	`String`	只读	变更广播	出厂默认IPv4模式
`DefaultFactoryIpAddr`	`String`	只读	变更广播	出厂默认IPv4地址
`DefaultFactoryIpv6Mode`	`String`	只读	变更广播	出厂默认IPv6模式
`DefaultFactoryIpv6Addr`	`String`	只读	变更广播	出厂默认IPv6地址
`DefaultFactoryIpVersion`	`String`	只读	变更广播	出厂默认网络模式

方法

`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`	方法的结果

自定义类型

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

属性

属性名	类型	可读写	信号通知	描述
`PrimaryNameServer`	`String`	读写	变更广播	主选域名服务器地址
`BackupNameServer`	`String`	读写	变更广播	备选域名服务器地址1
`TertiaryNameServer`	`String`	读写	变更广播	备选域名服务器地址2
`DHCPv4UseDNSServers`	`Boolean`	读写	变更广播	是否通过DHCPv4服务器来获取DNS服务器地址
`DHCPv6UseDNSServers`	`Boolean`	读写	变更广播	是否通过DHCPv6服务器来获取DNS服务器地址
`ServerIpVersion`	`String`	读写	变更广播	IPv4: DNS服务器ip版本是ipv4; IPv6: DNS服务器ip版本是ipv6

方法

`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

属性

属性名	类型	可读写	信号通知	描述
`GroupId`	`U8`	只读	变更广播	网口组ID
`Name`	`String`	只读	变更广播	网口组名
`OutType`	`U8`	只读	变更广播	网口组的类型:1:对内,2:对外,3:veth,4:计算节点近端维护内部网络,5:计算节点近端维护外出网络,6:SMM板浮动IP网络,7:SMM板出对板的内部网络,8:专用网口近端运维网络,9:机柜管理板内网,10: 机柜节点内网
`ActiveEthId`	`U8`	只读	变更广播	当前激活的网口号,例如eth2的话此处网口号为2
`InnerNetWork`	`String`	只读	变更广播	内网网段
`VLANId`	`U16`	只读	变更广播	VLANId，0表示VLAN关闭，反之为开启，范围为1-4094
`VLANEnabled`	`Boolean`	只读	变更广播	VLAN使能状态
`EthAlias`	`U8`	只读	变更广播	激活网口别名，有别名时取值最大为254，255表示没有别名网口
`IpAddr`	`String`	只读	变更广播	IPv4地址
`BaseIpAddr`	`String`	只读	变更广播	基准IPv4地址,和IpAdd作比较，判断是否根据槽位号生成过Ip
`SubnetMask`	`String`	只读	变更广播	子网掩码
`DefaultGateway`	`String`	只读	变更广播	IPv4网关
`IpPolicy`	`U8`	只读	变更广播	ip生成策略：0：根据默认IP地址,1：根据槽位和基准IP地址生成
`Status`	`Boolean`	只读	变更广播	该IP是否在工作状态中

bmc.kepler.Managers.EthernetInterfaces.InnerNetwork

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	内网ID
`EthId`	`U8`	只读	变更广播	网口号，表示IP在哪个eth口上
`EthName`	`String`	只读	变更广播	网口名称，带有vlan和别名，例如：eth0.702:1
`IpAddr`	`String`	只读	变更广播	内网IPv4地址
`SubnetMask`	`String`	只读	变更广播	IPv4子网掩码
`Status`	`Boolean`	只读	变更广播	该内网网口是否是running状态，即网口上是否有IP
`VLANId`	`U16`	只读	变更广播	VLANId，0表示VLAN关闭，反之为开启，范围为1-4094

bmc.kepler.Managers.EthernetInterfaces.Ipv4

属性

属性名	类型	可读写	信号通知	描述
`IpMode`	`String`	读写	变更广播	IPv4模式(DHCP/Static)
`IpAddr`	`String`	只读	变更广播	IPv4地址
`BackupIpAddr`	`String`	读写	变更广播	备份IPv4地址
`SubnetMask`	`String`	只读	变更广播	IPv4子网掩码
`BackupSubnetMask`	`String`	读写	变更广播	备份IPv4掩码
`DefaultGateway`	`String`	只读	变更广播	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

属性

属性名	类型	可读写	信号通知	描述
`IpMode`	`String`	读写	变更广播	DHCPv6:自动获取,Static:手动配置
`IpAddr`	`String`	只读	变更广播	IP地址
`PrefixLength`	`S32`	只读	变更广播	Ipv6地址子网掩码
`Scope`	`String`	只读	变更广播	enum(Link,Global)
`DefaultGateway`	`String`	只读	变更广播	默认网关

方法

`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

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	网口Id
`EthId`	`U8`	只读	变更广播	网口号
`DeviceId`	`U8`	只读	变更广播	设备Id
`DevicePortId`	`U8`	只读	变更广播	设备网口Id
`Silkscreen`	`String`	只读	变更广播	端口丝印信息
`Type`	`String`	只读	变更广播	网卡类型
`AdaptiveFlag`	`Boolean`	读写	变更广播	是否参与自适应标志
`LinkStatus`	`String`	读写	变更广播	link状态,Connected/Disconnected
`Mac`	`String`	只读	变更广播	对应Eth网口的Mac地址
`VLANEnabled`	`Boolean`	只读	变更广播	对应Eth的vlan状态
`VLANId`	`U16`	只读	变更广播	对应Eth的VLANId

bmc.kepler.Managers.FaultPrediction

属性

属性名	类型	可读写	信号通知	描述
`DfpEnable`	`Boolean`	读写	变更广播	硬盘故障预测功能开关: false,关闭;true,打开
`DiskLifespanEstimateAlarmEnabled`	`Boolean`	读写	变更广播	硬盘预估寿命过低告警开关: false,关闭;true,打开
`DiskLifespanEstimateEnabled`	`Boolean`	读写	变更广播	硬盘寿命预估功能开关: false,关闭;true,打开

bmc.kepler.Managers.FileTransfer

属性

属性名	类型	可读写	信号通知	描述
`HttpsTransferCertVerification`	`Boolean`	读写	变更广播	是否校验https证书

方法

`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.GraphicalConsole

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	读写	变更广播	控制台Id
`PersistentUSBConnectionEnabled`	`Boolean`	读写	变更广播	虚拟键鼠是否支持连接
`VideoEnabled`	`Boolean`	只读	变更广播	录像使能
`ScreenshotEnabled`	`Boolean`	只读	变更广播	最后一屏使能
`VideoAttributes`	`Array`	只读	变更广播	录像文件信息
`ScreenshotAttributes`	`Array`	只读	变更广播	截屏创建时间
`LocalKvmEnabled`	`Boolean`	读写	变更广播	本地kvm使能
`LocalKvmAutoDisable`	`Boolean`	读写	变更广播	远程KVM连接时自动关闭本地KVM设置，false表示不自动关闭本地KVM，true表示自动关闭本地KVM
`AutoOSLockEnabled`	`Boolean`	读写	变更广播	系统自动锁定使能
`AutoOSLockType`	`String`	读写	变更广播	系统自动锁定方式
`AutoOSLockKey`	`String[]`	读写	变更广播	系统自动锁定自定义快捷键
`AutoScreenshotTriggers`	`U32[]`	读写	变更广播	自动截屏触发类型

方法

`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

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	监控心跳的实体名称
`Status`	`String`	只读	变更广播	当前心跳状态

方法

`Beat`

描述： 心跳检测

bmc.kepler.Managers.IpmbEth

属性

属性名	类型	可读写	信号通知	描述
`IPMIChannelId`	`U8`	只读	变更广播	IPMI通道ID,关联IPMIChannel
`SMM1LinkStatus`	`U8`	只读	变更广播	与管理板0的通信状态，0：正常；1：异常
`SMM2LinkStatus`	`U8`	只读	变更广播	与管理板1的通信状态，0：正常；1：异常

bmc.kepler.Managers.LLDPInfo

属性

属性名	类型	可读写	信号通知	描述
`PortName`	`String`	只读	变更广播	LLDP 报文解析出来的端口号
`PortDesc`	`String`	只读	变更广播	LLDP 报文解析出来的端口描述
`SystemDesc`	`String`	只读	变更广播	LLDP 报文解析出来的交换机型号
`OrgSpec`	`String`	只读	变更广播	LLDP 报文解析出来的组织型号
`ManagementIP`	`U32`	只读	变更广播	LLDP 报文解析出来的管理地址
`SlotId`	`U8`	读写	变更广播	机柜端口对应的U位号，默认0，系列化计算之后反写到该属性

bmc.kepler.Managers.LldpConfig

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	LLDP服务使能：true为使能，默认不使能
`WorkMode`	`String`	读写	变更广播	LLDP工作模式，目前仅支持Tx模式
`TxDelaySeconds`	`S32`	读写	变更广播	LLDP Tx延时
`TxIntervalSeconds`	`S32`	读写	变更广播	LLDP Tx间隔时间
`TxHold`	`S32`	读写	变更广播	LLDP Tx保持时间

bmc.kepler.Managers.LocalOMService.USB

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	资源Id
`Supported`	`Boolean`	只读	变更广播	是否支持USB type-c功能
`Presence`	`Boolean`	只读	变更广播	面板USB口是否在位
`Enabled`	`Boolean`	只读	变更广播	USB typc-c功能使能状态
`USBDevicePresence`	`Boolean`	只读	变更广播	USB设备在位状态

方法

`SetEnabled`

描述： 设置USB typc-c功能使能状态

输入参数：

参数名	类型	描述
`Enabled`	`Boolean`	使能状态

`StopUSBNetwork`

描述： 关闭usb驱动，停止usb rndis服务

bmc.kepler.Managers.LogService

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	指定日志服务资源的名称
`OverWritePolicy`	`String`	只读	变更广播	指定日志服务资源的覆盖策略,取值:Unknown, WrapsWhenFull, NeverOverWrites
`ServiceEnabled`	`Boolean`	只读	变更广播	指定日志服务资源的启用状态

方法

`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

属性

属性名	类型	可读写	信号通知	描述
`OperationLogAlmostFull`	`U8`	只读	变更广播	表示操作日志是否超90%
`SecurityLogAlmostFull`	`U8`	只读	变更广播	表示安全日志是否超90%

方法

`Dump`

描述： 日志一键收集

输入参数：

参数名	类型	描述
`DomainUser`	`U8`	用户
`FilePath`	`String`	文件路径

输出参数：

参数名	类型	描述
`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.MgmtPortCapability

属性

属性名	类型	可读写	信号通知	描述
`DedicatedSupported`	`Boolean`	只读	变更广播	单板是否支持专用网口
`NcsiEthNum`	`U8`	只读	变更广播	0：表示连接在Eth0上 1：表示连接在Eth1上
`AggregationSupported`	`Boolean`	只读	变更广播	单板是否支持网络汇聚功能
`DedicatedVlanSupported`	`Boolean`	只读	变更广播	单板是否支持专用网口VLAN的功能
`NcsiPowerDomain`	`U8`	只读	变更广播	当前NCSI绑定的网卡的电源域 0:Standby, 1:Vcc

bmc.kepler.Managers.Multihost

属性

属性名	类型	可读写	信号通知	描述
`HostType`	`String`	只读	变更广播	表征当前机型的Host类型，默认是Singlehost
`HostCount`	`U8`	只读	变更广播	表征当前机型的Host个数，默认是1，取值范围：[1 - 63]

bmc.kepler.Managers.NandFlash

属性

属性名	类型	可读写	信号通知	描述
`Vendor`	`String`	只读	变更广播	nand厂商
`WriteProtection`	`U8`	读写	变更广播	Nand Flash写保护状态,写入与否:0(允许)/1(禁止)
`LifeTime`	`U8`	只读	变更广播	剩余寿命百分比,支持Nand Flash已用寿命超限严重告警
`LifeTimeThreshold`	`U8`	只读	变更广播	寿命阈值
`PreEOL`	`U8`	只读	变更广播	(end of life)Nand Flash的PreEOL信息(通过平均预留块来反映设备寿命)，
`OverWrite`	`U8`	只读	变更广播	写入量是否超过门限,1:超过/0:未超过
`WriteThreshold`	`U8`	只读	变更广播	Nand Flash写入量,单位GB
`RWTestState`	`U8`	只读	变更广播	读写测试状态
`MaxEraseCount`	`S32`	只读	变更广播	最大擦除次数(非JPR型号海力士支持),不支持厂商置-1
`RemainingEraseCount`	`S32`	只读	变更广播	剩余擦除次数(非JPR型号海力士支持),不支持厂商置-1
`EraseCountPerDays`	`S32[]`	只读	变更广播	最近15天每天擦除次数(非国产海力士支持)，不支持或无数据为空
`TotalWriteAmount`	`Double`	只读	变更广播	开机至今总写入量,单位GB
`TotalWriteAmountIn15Days`	`Double`	只读	变更广播	最近15天总写入量,单位GB
`WriteAmountPerDay`	`Double[]`	只读	变更广播	最近15天每天写入量,无数据时为空,单位GB
`ReservedBlocks`	`S32`	只读	变更广播	剩余预留块(非JPR型号海力士支持),不支持厂商置-1
`RuntimeBadBlocks`	`S32`	只读	变更广播	坏块数量(非JPR型号海力士支持),不支持厂商置-1

方法

`ClearStatistics`

描述： 清除写入量统计

bmc.kepler.Managers.NatConfig

方法

`AddNatRule`

描述： 添加网络规则

输入参数：

参数名	类型	描述
`ServiceName`	`String`	服务名称
`ProtocolInfo`	`Array`	调用此方法向bmc_network添加nat规则

`UpdateNatRule`

描述： 更新网络规则

输入参数：

参数名	类型	描述
`ServiceName`	`String`	服务名称
`ProtocolInfo`	`Array`	调用此方法向bmc_network更新nat规则

自定义类型

KeyValueTable 结构：

字段名	类型	描述
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

属性

属性名	类型	可读写	信号通知	描述
`AntiDNSRebindEnabled`	`Boolean`	读写	变更广播	防DNS重绑定使能状态
`ProtocolVersion`	`String`	读写	变更广播	HTTP协议版本，用户可设置，用户修改后nginx生效

bmc.kepler.Managers.NetworkProtocol.PortConfig

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	使能状态
`PortCount`	`U8`	只读	变更广播	端口数量, 支持0~2个端口号
`DefaultPort`	`U16`	只读	变更广播	默认主端口号
`Port`	`U16`	读写	变更广播	当前主端口号
`DefaultSparePort`	`U16`	只读	变更广播	默认备端口号
`SparePort`	`U16`	读写	变更广播	当前备端口号

方法

`SetPorts`

描述： 设置网络协议的端口号

输入参数：

参数名	类型	描述
`Port`	`U16`	当前端口号
`SparePort`	`U16`	当前备端口号

bmc.kepler.Managers.NetworkProtocol.SNMP

属性

属性名	类型	可读写	信号通知	描述
`SNMPv1Enabled`	`Boolean`	读写	变更广播	SNMPv1使能状态
`SNMPv2cEnabled`	`Boolean`	读写	变更广播	SNMPv2c使能状态
`SNMPv3Enabled`	`Boolean`	读写	变更广播	SNMPv3使能状态
`SysName`	`String`	读写	变更广播	系统名称
`SysNameSyncEnabled`	`Boolean`	读写	变更广播	是否从主机名同步系统名
`SysContact`	`String`	读写	变更广播	系统联系人
`SysLocation`	`String`	读写	变更广播	系统位置
`EngineId`	`String`	只读	变更广播	引擎Id

bmc.kepler.Managers.NetworkProtocol.SSH

属性

属性名	类型	可读写	信号通知	描述
`PasswordAuthEnabled`	`Boolean`	读写	变更广播	SSH密码认证使能状态

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithm

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	算法名称
`Enabled`	`Boolean`	读写	变更广播	使能状态

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithms

方法

`SetAlgorithmsState`

描述： 设置算法使能状态

输入参数：

参数名	类型	描述
`AlgorithmsState`	`Array`	算法使能状态

自定义类型

AlgorithmsStateItem 结构：

字段名	类型	描述
Name	String
Enabled	Boolean

bmc.kepler.Managers.NodeLocation

属性

属性名	类型	可读写	信号通知	描述
`LocationId`	`U8`	读写	变更广播	当前节点所在的位置标识，接受系列化计算之后反写，默认0
`LocationType`	`String`	只读	变更广播	当前节点所在的位置描述，支持以下几种：Backplane/Bay/Connector/Slot/Socket

bmc.kepler.Managers.Ntp

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	NTP使能状态,是否开启NTP客户端
`NTPMode`	`String`	读写	变更广播	配置服务器ip模式,Static手动配置ip,IPv4/IPv6表示依赖DHCP服务器获取NTP服务器ip地址
`NTPIpVersion`	`String`	读写	变更广播	NTPIp类型
`PreferServer`	`String`	读写	变更广播	首选服务器
`AlternateServer`	`String`	读写	变更广播	备用服务器
`ExtraServers`	`String[]`	读写	变更广播	额外服务器
`MinPoll`	`U8`	读写	变更广播	最小轮询间隔,代表两个NTP报文的最小间隔时间,配置3代表2秒的3次方
`MaxPoll`	`U8`	读写	变更广播	最大轮询间隔
`NTPServerCount`	`U8`	读写	变更广播	支持可配置NTPserver的个数
`SyncResult`	`U8`	只读	变更广播	BMC与NTP服务器同步的结果

方法

`SetPollingInterval`

描述： 同时设置Ntp服务的最大和最小轮训间隔

输入参数：

参数名	类型	描述
`MinPoll`	`U8`	最小轮询间隔
`MaxPoll`	`U8`	最大轮询间隔

`SetNtpExtraServers`

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

输入参数：

参数名	类型	描述
`NTPServerCount`	`U8`	支持的NTPserver 的个数，仅支持3个或者6个，默认为3个
`ExtraServers`	`String[]`	备用服务器地址

bmc.kepler.Managers.Ntp.Auth

属性

属性名	类型	可读写	信号通知	描述
`AuthEnabled`	`Boolean`	读写	变更广播	服务器身份认证使能开关。true:使能，false:未使能
`GroupKeyStatus`	`U8`	只读	变更广播	表征NTP服务端密钥导入状态。0:未导入，1:已导入

方法

`ImportGroupKey`

描述： 导入NTP组密钥

输入参数：

参数名	类型	描述
`FilePath`	`String`	上传密钥的路径

bmc.kepler.Managers.Package

属性

属性名	类型	可读写	信号通知	描述
`Customer`	`String`	读写	变更广播	定制发货的客户名称
`Version`	`String`	读写	变更广播	客户定制套餐版本
`Provider`	`String`	读写	变更广播	定制版本提供商

bmc.kepler.Managers.RMCPCipherSuites

属性

属性名	类型	可读写	信号通知	描述
`SuitId`	`U8`	只读	变更广播	算法套件Id,取值: 1,2,3,17
`Enabled`	`Boolean`	读写	变更广播	加密套件的使能状态
`AuthenticationAlgorithm`	`String`	只读	变更广播	加密算法名称
`IntegrityAlgorithm`	`String`	只读	变更广播	一致性算法名称
`ConfidentialityAlgorithm`	`String`	只读	变更广播	验证算法名称

bmc.kepler.Managers.Rmcp.SessionService

属性

属性名	类型	可读写	信号通知	描述
`MaxConcurrentSessions`	`U8`	读写	变更广播	RMCP会话最大数

bmc.kepler.Managers.SOC

属性

属性名	类型	可读写	信号通知	描述
`BlackBoxEnabled`	`Boolean`	读写	变更广播	设置黑匣子使能开关状态,false(关闭）/true(打开）
`PCIeControllerEnabled`	`Boolean`	读写	变更广播	设置PCIe接口使能开关状态,false(关闭）/true(打开）
`Temperature`	`U16`	只读	变更广播	BMC核心温度
`TemperatureThreshold`	`U16`	只读	变更广播	BMC核心温度告警阈值
`Name`	`String`	只读	变更广播	芯片名字
`Version`	`String`	只读	变更广播	芯片版本，如V100
`Designator`	`String`	只读	变更广播	芯片位置，如U82
`DIEID`	`String`	只读	变更广播	DIE(裸片)ID(标识)
`ResetType`	`U8`	只读	变更广播	BMC复位原因 0 AC复位，2 软复位
`DDRSelfTestResult`	`U8`	只读	变更广播	DDR自检结果，bmc启动检查一次 0 无异常 1 发生异常
`DDRSingleBitECCStatistics`	`U32`	只读	变更广播	DDR ECC错误检查，1小时例测一次单bit结果
`DDRMultiBitECCStatistics`	`U32`	只读	变更广播	DDR ECC错误检查，1小时例测一次多bit结果
`StartupDuration`	`U16`	只读	变更广播	BMC启动时间规格
`LastResetTime`	`String`	只读	变更广播	表征BMC上一次重启时间

bmc.kepler.Managers.SOC.BlackBox

方法

`Dump`

描述： 黑匣子信息转储

输入参数：

参数名	类型	描述
`Length`	`U32`	读取数据长度，单位Byte
`Filename`	`String`	指定数据输出文件名

bmc.kepler.Managers.SOC.Coprocessor

属性

属性名	类型	可读写	信号通知	描述
`MemorySizeBytes`	`U32`	读写	变更广播	设置环境变量copBootSize, 最小值16M，最大值200M

bmc.kepler.Managers.SOC.EfuseUpgrade

方法

`Write`

描述： efuse升级数据写入接口

输入参数：

参数名	类型	描述
`Data`	`U8[]`	efuse升级数据

bmc.kepler.Managers.SOC.Env

属性

属性名	类型	可读写	信号通知	描述
`LoadCompleted`	`Boolean`	读写	变更广播	环境变量是否加载完成
`IsChanged`	`Boolean`	读写	变更广播	环境变量值是否存在变更
`ActiveMode`	`Enum`	读写	变更广播	环境变量生效方式。0:自动生效; 1:复位BMC; 2:复位BMC和安全核，不影响业务系统状态; 3:复位BMC和安全核，需要业务系统下电状态下; 4: AC掉电

自定义类型

EnvActiveModes 枚举：

字段名	类型	数值
None	Enum	0
ResetBMC	Enum	1
ResetBMCAndSecureCore	Enum	2
ResetBMCAndSecureCoreOnPowerDown	Enum	3
ACCycle	Enum	4

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.NandFlashCtrl

属性

属性名	类型	可读写	信号通知	描述
`WriteProtection`	`Boolean`	读写	变更广播	FLASH写保护状态

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`

描述： 查询安全启动状态信息

输出参数：

参数名	类型	描述
`SecureBootParameteers`	`U8[]`	安全启动状态信息(EFUSE烧录、密钥导入等)

自定义类型

CertificateHashSignMode 枚举：

字段名	类型	数值
PKCSSignMode	Enum	0
PSSSignMode	Enum	1

bmc.kepler.Managers.SOC.SecureCore.TPCM

属性

属性名	类型	可读写	信号通知	描述
`Presence`	`Boolean`	只读	变更广播	soc核心在位状态

方法

`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`	眼图测试结果

自定义类型

PortType 枚举：

字段名	类型	数值
PCIe0	Enum	0
PCIe1	Enum	1
GMAC2	Enum	2
GMAC3	Enum	3
USB	Enum	4

ScopeSel 枚举：

字段名	类型	数值
BeforeAFESampling	Enum	0
AfterAFESampling	Enum	1

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 枚举：

字段名	类型	数值
Device	Enum	0
Host	Enum	1

bmc.kepler.Managers.SOL

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	只读	变更广播	CLI_SOL可用状态
`Mode`	`U8`	只读	变更广播	共享模式为0,独占模式1
`SerialDirect`	`U8`	只读	变更广播	串口方向:无方向为0,系统os串口方向为1,BMC串口方向为2
`Timeout`	`U16`	只读	变更广播	会话超时时间,minutes

方法

`InitSession`

描述： 初始化会话

输入参数：

参数名	类型	描述
`Mode`	`U8`	会话模式

输出参数：

参数名	类型	描述
`Result`	`S8`	初始化结果

`SetTimeout`

描述： 设置超时时间

输入参数：

参数名	类型	描述
`Minutes`	`U16`	超时时间

输出参数：

参数名	类型	描述
`Result`	`S8`	设置成功 0 /失败 1

bmc.kepler.Managers.SOL.Session

属性

属性名	类型	可读写	信号通知	描述
`Activated`	`Boolean`	只读	变更广播	SOL会话激活状态
`Type`	`String`	只读	变更广播	会话类型,取值: CLI, IPMI
`ClientAddress`	`String`	只读	变更广播	客户端会话地址
`ActivatedTime`	`String`	只读	变更广播	会话创建时间
`UserName`	`String`	只读	变更广播	登录用户名

方法

`Deactivate`

描述： 停用SOL会话

输出参数：

参数名	类型	描述
`Result`	`S8`	结果：0，成功；1，会话ID超出范围；2，RMCP_SOL已激活；3，会话已关闭

bmc.kepler.Managers.SSDPConfig

属性

属性名	类型	可读写	信号通知	描述
`ProtocolEnabled`	`Boolean`	只读	变更广播	协议使能状态
`Mode`	`String`	读写	变更广播	SSDP运行的模式
`Type`	`String`	只读	变更广播	BMC为__initialized.__bmc-
`EthernetInterface`	`String`	只读	变更广播	使用的网口
`NotifyMulticastIntervalSeconds`	`U32`	读写	变更广播	Alive消息发送的时间间隔
`IPv4Addr`	`String`	只读	变更广播	SSDP组播IPv4地址
`IPv6Addr`	`String`	只读	变更广播	SSDP组播IPv6地址
`NotifyTTL`	`U32`	读写	变更广播	SSDP hop count

方法

`SetNotifyIPv6Scope`

描述： 设置ipv6 scope

输入参数：

参数名	类型	描述
`Scopy`	`String`	可选值（地址）为Link（FF02::C）、Site（FF05::C）、Organization(FF08::C),其它是非法值

bmc.kepler.Managers.Security.Asset

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	部件名称
`StandardDescription`	`String`	只读	变更广播	基准度量内容，由部件信息组合，签名而来
`StandardDigest`	`String`	只读	变更广播	度量基准值

bmc.kepler.Managers.Security.Assets

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	只读	变更广播	融合身份认证功能是否可用
`ServerConfigDigest`	`String`	只读	变更广播	供应链配置指纹信息

方法

`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	部件度量值

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	使能状态
`Content`	`String`	读写	变更广播	展示的banner内容
`DefaultContent`	`String`	读写	变更广播	默认的banner内容

bmc.kepler.Managers.Security.DICE

方法

`ExportCSR`

输入参数：

参数名	类型	描述
`Path`	`String`	CSR文件导出路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	ExportCSR Task Id

`ImportCertificate`

输入参数：

参数名	类型	描述
`Path`	`String`	证书路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	ImportCertificate Task Id

`ExportCertificateChain`

输入参数：

参数名	类型	描述
`Path`	`String`	导出DICE证书链目录
`Nonce`	`String`	挑战随机数字符串，如0F12082A11121314

输出参数：

参数名	类型	描述
`TaskId`	`U32`	ExportCertificateChain Task Id

`ExportHardwareComponentsCertficateChain`

输入参数：

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

输出参数：

参数名	类型	描述
`TaskId`	`U32`	ExportCertificateChain Task Id

bmc.kepler.Managers.Security.File

方法

`Copy`

输入参数：

参数名	类型	描述
`SrcFile`	`String`	源文件路径
`DstFile`	`String`	目标文件路径
`Uid`	`U32`	目标文件属主
`Gid`	`U32`	目标文件属组

`Move`

输入参数：

参数名	类型	描述
`SrcFile`	`String`	源文件路径
`DstFile`	`String`	目标文件路径
`Uid`	`U32`	目标文件属主
`Gid`	`U32`	目标文件属组

`Chmod`

输入参数：

参数名	类型	描述
`DstFile`	`String`	目标文件路径
`FileMode`	`U32`	目标文件权限

`Chown`

输入参数：

参数名	类型	描述
`DstFile`	`String`	目标文件路径
`Uid`	`U32`	目标文件属主
`Gid`	`U32`	目标文件属组

`Delete`

输入参数：

参数名	类型	描述
`DstFile`	`String`	目标文件路径

`Create`

输入参数：

参数名	类型	描述
`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`	校验成功或失败

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

属性

属性名	类型	可读写	信号通知	描述
`CurrentMode`	`String`	只读	变更广播	当前系统状态(Normal:正常模式,Recovery:最小系统模式)

方法

`EnterRecoveryMode`

输出参数：

参数名	类型	描述
`Result`	`Boolean`	进入最小系统成功或失败

`SetIDSConfig`

输入参数：

参数名	类型	描述
`Config`	`String`	从网管透传入侵检测配置信息到安全模块

bmc.kepler.Managers.Security.TlsConfig.CipherSuit

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	只读	变更广播	使能状态
`SuitName`	`String`	只读	变更广播	算法名称

bmc.kepler.Managers.Security.TlsConfig.CipherSuits

方法

`SetSslCipherSuit`

输入参数：

参数名	类型	描述
`SuitArray`	`Array`
`EnableArray`	`Boolean[]`

自定义类型

SslCipherSuit 枚举：

字段名	类型	数值
ECDHE_RSA_AES256_GCM_SHA384	Enum	0
ECDHE_ECDSA_AES256_GCM_SHA384	Enum	1
DHE_DSS_AES256_GCM_SHA384	Enum	2
DHE_RSA_AES256_GCM_SHA384	Enum	3
ECDHE_RSA_AES128_GCM_SHA256	Enum	4
ECDHE_ECDSA_AES128_GCM_SHA256	Enum	5
DHE_DSS_AES128_GCM_SHA256	Enum	6
DHE_RSA_AES128_GCM_SHA256	Enum	7
DHE_PSK_AES128_GCM_SHA256	Enum	8
DHE_PSK_AES256_GCM_SHA384	Enum	9
DHE_PSK_CHACHA20_POLY1305	Enum	10
ECDHE_RSA_CHACHA20_POLY1305	Enum	11
ECDHE_PSK_CHACHA20_POLY1305	Enum	12
DHE_RSA_AES128_CCM	Enum	13
DHE_RSA_AES256_CCM	Enum	14
DHE_RSA_CHACHA20_POLY1305	Enum	15
DHE_PSK_AES128_CCM	Enum	16
DHE_PSK_AES256_CCM	Enum	17
ECDHE_ECDSA_AES128_CCM	Enum	18
ECDHE_ECDSA_AES256_CCM	Enum	19
ECDHE_ECDSA_CHACHA20_POLY1305	Enum	20
TLS_CHACHA20_POLY1305_SHA256	Enum	21
TLS_AES_256_GCM_SHA384	Enum	22
TLS_AES_128_GCM_SHA256	Enum	23
TLS_DHE_RSA_WITH_AES_256_CBC_SHA	Enum	24
TLS_DHE_RSA_WITH_AES_128_CBC_SHA	Enum	25
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA	Enum	26
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA	Enum	27

bmc.kepler.Managers.Security.TlsConfig.TlsVersion

属性

属性名	类型	可读写	信号通知	描述
`Version`	`Enum`	读写	变更广播	TLS版本
`TLS_1_0_Enabled`	`Boolean`	读写	变更广播	TLS1.0版本使能
`TLS_1_1_Enabled`	`Boolean`	读写	变更广播	TLS1.1版本使能
`TLS_1_2_Enabled`	`Boolean`	读写	变更广播	TLS1.2版本使能
`TLS_1_3_Enabled`	`Boolean`	读写	变更广播	TLS1.3版本使能

方法

`GetTlsCapabilities`

输出参数：

参数名	类型	描述
`TlsCapabilities`	`Array`	TLS支持能力,格式[TLS版本名:支持状态]

自定义类型

SslVersion 枚举：

字段名	类型	数值
TLS_1_2	Enum	0
TLS_1_3	Enum	1

TlsObject 结构：

字段名	类型	描述
TlsName	String	TLS版本名, 包括TLS1_0, TLS1_1, TLS1_2, TLS1_3
IsSupported	Boolean	支持状态

bmc.kepler.Managers.SerialManagement

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	串口链路的Id
`Availability`	`U8`	只读	变更广播	串口链路的可用性
`CurrentConnectStatus`	`U8`	只读	变更广播	当前串口连接状态，0：未连接，1：已连接
`Source`	`String`	只读	变更广播	链路关系源端
`Destination`	`String`	只读	变更广播	链路关系对端

方法

`SetConnectStatus`

描述： 设置串口链路状态

输入参数：

参数名	类型	描述
`NeedSaved`	`Boolean`	此次串口连接方向是否持久化

bmc.kepler.Managers.SerialManagement.Config

方法

`Reset`

描述： 恢复串口管理配置

bmc.kepler.Managers.SnmpService.SnmpCommunity

属性

属性名	类型	可读写	信号通知	描述
`LongCommunityEnabled`	`Boolean`	读写	变更广播	长密码开关使能状态
`RwCommunityEnabled`	`Boolean`	读写	变更广播	读写团体名使能

方法

`SetRwCommunity`

输入参数：

参数名	类型	描述
`RwCommunity`	`String`

`SetRoCommunity`

输入参数：

参数名	类型	描述
`RwCommunity`	`String`

`GetSnmpCommunity`

输出参数：

参数名	类型	描述
`RwCommunity`	`String`
`RoCommunity`	`String`

`SetSnmpCommunityLoginRule`

输入参数：

参数名	类型	描述
`LoginRuleIds`	`String[]`

bmc.kepler.Managers.SwitchConnections

方法

`GetSwitchConnections`

描述： 获取交换机连接信息

输出参数：

参数名	类型	描述
`Connections`	`String`	交换机信息

bmc.kepler.Managers.Syslog

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	syslog服务使能
`MessageFormat`	`String`	读写	变更广播	消息格式
`ServerIdentitySource`	`String`	读写	变更广播	主机标识
`LowestSeverity`	`String`	读写	变更广播	告警级别
`Protocol`	`String`	读写	变更广播	传输协议
`AuthenticateMode`	`String`	读写	变更广播	认证模式

bmc.kepler.Managers.Syslog.Report

方法

`ReportControl`

描述： 通知组件syslog日志上报

输入参数：

参数名	类型	描述
`Type`	`TypeData`
`Priority`	`U8`

自定义类型

TypeData 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Managers.Syslog.Server

属性

属性名	类型	可读写	信号通知	描述
`MemberId`	`U8`	只读	变更广播	数组序号
`Enabled`	`Boolean`	读写	变更广播	通道使能
`Address`	`String`	读写	变更广播	服务器地址
`Port`	`U16`	读写	变更广播	服务器端口号
`LogType`	`String[]`	读写	变更广播	日志类型

bmc.kepler.Managers.Syslog.Servers

方法

`SubmitTestEvent`

描述： 发送测试事件

输入参数：

参数名	类型	描述
`MemberId`	`U8`	数组序号

bmc.kepler.Managers.SystemManager

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	读写	变更广播	上层管理软件Name
`Id`	`String`	读写	变更广播	上层管理软件Id
`Ip`	`String`	读写	变更广播	上层管理软件IP
`LockedTime`	`String`	读写	变更广播	上层管理软件纳管锁定BMC的时间

bmc.kepler.Managers.TPCM.BaseInfo

属性

属性名	类型	可读写	信号通知	描述
`TCMManufacturer`	`U16`	只读	变更广播	TCM厂商ID
`TCMVersion`	`U32`	只读	变更广播	TCM版本
`TPCMLogVersion`	`U32`	只读	变更广播	TPCM日志版本
`TsbEnableStatus`	`Boolean`	只读	变更广播	TSB使能

bmc.kepler.Managers.TPCM.Config

属性

属性名	类型	可读写	信号通知	描述
`TrustedCenterServerAddr`	`String`	读写	变更广播	外部可信中心IP
`MeasureEnable`	`Boolean`	读写	变更广播	度量使能
`MeasureControlPolicy`	`Boolean`	读写	变更广播	度量控制策略

方法

`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格式返回

bmc.kepler.Managers.TPCM.Measured

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	度量固件名
`Version`	`String`	只读	变更广播	度量固件版本
`PCRName`	`String`	只读	变更广播	平台状态寄存器
`ActualDigest`	`String`	只读	变更广播	实际度量值
`StandardDigest`	`String`	读写	变更广播	度量基准值
`ComparedResult`	`U8`	只读	变更广播	度量结果
`ControlAction`	`U8`	只读	变更广播	控制结果

bmc.kepler.Managers.Time

属性

属性名	类型	可读写	信号通知	描述
`DateTime`	`String`	只读	变更广播	遵循ISO 8601标准的日期时间字符串
`TimeZoneConfigurable`	`Boolean`	只读	变更广播	时区是否可配置
`DateTimeLocalOffset`	`String`	只读	变更广播	时区偏移量
`TimeZoneName`	`String`	读写	变更广播	时区名字
`SyncStatus`	`Boolean`	只读	变更广播	当前BMC时间是否已同步
`DSTEnabled`	`Boolean`	只读	变更广播	夏令时是否已开启

方法

`SetDateTime`

描述： 设置BMC时间相关属性

输入参数：

参数名	类型	描述
`TimeParams`	`KeyValueTable`	TimeZone：设置的时区，TimeStamp：时间戳，DSTEnable：夏令时使能状态（true、false）

自定义类型

KeyValueTable 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Managers.USBAuthentication

方法

`SetDecryptPassword`

输入参数：

参数名	类型	描述
`USBDecryptPassword`	`String`

`DecryptFile`

输入参数：

参数名	类型	描述
`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控制器数据传输校验位

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

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	设置sol使能状态
`SystemLogSize`	`U32`	读写	变更广播	系统串口日志大小

方法

`Export`

描述： 导出串口日志

输入参数：

参数名	类型	描述
`Type`	`String`	导出数据的类型，可选值：SYS COM/ALL
`FilePath`	`String`	导出数据的文件路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务标识

bmc.kepler.Managers.Ums

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	U盘名字
`CapacityKB`	`U32`	只读	变更广播	u盘容量单位 kByte
`FileSystem`	`String`	只读	变更广播	U盘flash对应的设备名称
`BmcAccessMode`	`String`	只读	变更广播	U盘在BMC侧的读写权限
`OsAccessMode`	`String`	只读	变更广播	U盘在主机侧的读写权限
`FlashDev`	`String`	只读	变更广播	U盘flash对应的设备名称
`MountPoint`	`String`	只读	变更广播	u盘挂载点
`Enable`	`Boolean`	只读	变更广播	U盘功能使能
`BiosSupport`	`Boolean`	只读	变更广播	BIOS支持U盘功能标志
`FreeUpdateSpaceBytes`	`U32`	只读	变更广播	U盘更新文件夹剩余容量单位 byte
`MaxUpdateSpaceBytes`	`U32`	读写	变更广播	U盘更新文件夹最大容量单位 byte

方法

`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

属性

属性名	类型	可读写	信号通知	描述
`PackageCount`	`U8`	只读	变更广播	U盘中含有BMA安装包的个数
`Packages`	`Object`	只读	变更广播	type: U盘中BMA安装包支持的操作系统类型, version: U盘中BMA安装包的版本号
`State`	`U8`	只读	变更广播	板载BMA功能可使用状态, 0: NAND Flash中含有BMA分区且分区中存在BMA安装包; 1: NAND Flash中无BMA分区, 2: 分区中无BMA安装包, 0xFF: 默认值

方法

`UpgradePackage`

描述： 升级iBMA安装包

输入参数：

参数名	类型	描述
`ImageURI`	`String`	升级包地址
`SignatureURI`	`String`	升级包地址
`CrlURI`	`String`	升级包CRL文件地址

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

`DeletePackage`

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

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Managers.Ums.SP

属性

属性名	类型	可读写	信号通知	描述
`ConfigFileReady`	`Boolean`	读写	变更广播	u盘部件配置或升级包下发到NAND FLASH完成标志
`SysRestartDelaySeconds`	`U32`	读写	变更广播	u盘从SP操作(配置和升级)完后到复位主机系统之间间隔时间, 单位为秒
`SPTimeout`	`U32`	读写	变更广播	SP部署超时时间300 ~ 86400，默认7200
`SPFinished`	`Boolean`	读写	变更广播	SP部署事务状态
`SPDeviceInfoCollectEnabled`	`Boolean`	读写	变更广播	SP设备信息文件收集开关
`SPAutoUpgradeSupported`	`Boolean`	只读	变更广播	是否支持使用Auto模式升级SP
`StartMode`	`U8`	读写	变更广播	u盘进入SP方式标志 0：手动按F6进入SP，1：自动进入SP
`DataExist`	`Boolean`	只读	变更广播	bmc中是否存在sp程序
`BootedFlag`	`Boolean`	读写	变更广播	从SP启动过的标志，1表示从SP启动过；0表示没有从SP启动过，重启持久化
`DeviceInfoCollectState`	`U8`	只读	变更广播	SP设备信息文件收集流程状态
`DeviceInfoParseState`	`U8`	只读	变更广播	SP设备信息文件解析流程状态
`BootCount`	`U32`	只读	变更广播	SP启动次数

方法

`UpdateSP`

描述： 升级SP

输入参数：

参数名	类型	描述
`ImageURI`	`String`	升级文件路径
`UpdateMode`	`String`	升级模式
`ActiveMethod`	`String`	生效方法

`UpdateFirmware`

描述： 升级固件

输入参数：

参数名	类型	描述
`ImageURI`	`String`	升级文件路径
`ImageCerURI`	`String`	升级文件对应的认证文件远程路径
`Parameter`	`String`	附带参数
`ActiveMethod`	`String`	生效方法

`GetOSInstallPara`

描述： 查询OS部署参数

输出参数：

参数名	类型	描述
`Content`	`String`	OS部署参数

`SetOSInstallPara`

描述： 设置OS部署参数

输入参数：

参数名	类型	描述
`Content`	`String`	OS部署参数

`GetSPServiceSignature`

描述： 查询SP服务的验签方法

输出参数：

参数名	类型	描述
`Signature`	`String`	SP服务的验签方法

`GetSPResult`

描述： 查询SP服务的任务执行结果

输出参数：

参数名	类型	描述
`Content`	`String`	查询结果

`GetSPStatus`

描述： 查询SP状态

输出参数：

参数名	类型	描述
`SPStatus`	`String`	SP状态

`DumpSpinfo`

描述： 收集spinfo日志

输入参数：

参数名	类型	描述
`FilePath`	`String`	文件路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Managers.Ums.SP.Plugin

方法

`Install`

描述： 安装SP插件

输入参数：

参数名	类型	描述
`PackageURI`	`String[]`	插件文件列表
`SignatureFileURI`	`String[]`	插件签名文件列表

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

`Delete`

描述： 卸载SP插件

输入参数：

参数名	类型	描述
`PluginName`	`String`	卸载的插件名

`IsPluginInstalled`

描述： 校验插件是否已安装

输入参数：

参数名	类型	描述
`PluginName`	`String`	校验的插件名

输出参数：

参数名	类型	描述
`Result`	`Boolean`	校验结果

`GetPluginInfo`

描述： 获取插件详细信息

输入参数：

参数名	类型	描述
`PluginName`	`String`	输入插件名获取指定插件详细信息, 输入All获取所有插件名

输出参数：

参数名	类型	描述
`PluginInfos`	`String`	查询结果

bmc.kepler.Managers.Ums.SP.Schema

方法

`Update`

描述： 更新SP shcema文件

输入参数：

参数名	类型	描述
`ChecksumValue`	`String`	鉴权参数
`FileName`	`String`	文件名

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Managers.Ums.SP.Version

属性

属性名	类型	可读写	信号通知	描述
`APPVersion`	`String`	只读	变更广播	SP应用程序版本
`OSRevision`	`String`	只读	变更广播	自定义的SP的OS版本
`OSVersion`	`String`	只读	变更广播	SP中欧拉OS的版本
`MajorVersion`	`String`	只读	变更广播	SP中主版本
`DataVersion`	`String`	只读	变更广播	SP中驱动版本
`ComponentsMessages`	`String`	只读	变更广播	SP中组件信息：所有的组件名字和各组件对应的本号

bmc.kepler.Managers.Ums.Upgrade

属性

属性名	类型	可读写	信号通知	描述
`InUpgrade`	`Boolean`	只读	变更广播	当前是否处于升级中
`UpgradeProgress`	`U8`	只读	变更广播	升级进度
`TransProgress`	`S32`	只读	变更广播	u盘文件传输进度
`TransFileName`	`String`	只读	变更广播	当前正在传输的文件
`Status`	`String`	只读	变更广播	升级状态
`MessageId`	`String`	只读	变更广播	升级出错时错误消息的id
`MessageArgs`	`String[]`	只读	变更广播	升级出错时错误消息的参数

bmc.kepler.Managers.UsbDevice.Cdrom

属性

属性名	类型	可读写	信号通知	描述
`ConnectState`	`U32`	只读	变更广播	连接状态,未连接为0,连接为1

方法

`Connect`

描述： Cdrom设备建立连接

输出参数：

参数名	类型	描述
`UsbId`	`U32`	复合设备USB口
`FuncId`	`U32`	功能设备ID

`Disconnect`

描述： Cdrom设备断开连接

bmc.kepler.Managers.UsbDevice.Floppy

属性

属性名	类型	可读写	信号通知	描述
`ConnectState`	`U32`	只读	变更广播	连接状态,未连接为0,连接为1
`Enabled`	`Boolean`	读写	变更广播	软驱使能标志,由kvm_vmm设置

方法

`Connect`

描述： 软驱建立连接

输出参数：

参数名	类型	描述
`UsbId`	`U32`	复合设备USB口
`FuncId`	`U32`	功能设备ID

`Disconnect`

描述： 软驱断开连接

bmc.kepler.Managers.UsbDevice.KeyMouse

属性

属性名	类型	可读写	信号通知	描述
`ConnectState`	`U32`	只读	变更广播	连接状态,未连接为0,连接为1
`MouseMode`	`U32`	读写	变更广播	键鼠模式

方法

`Connect`

描述： 鼠标建立连接

输出参数：

参数名	类型	描述
`KeyUsbId`	`U32`	复合设备USB口
`KeyFuncId`	`U32`	功能设备ID
`MouseUsbId`	`U32`	鼠标USBID
`MouseFuncId`	`U32`	鼠标功能设备ID

`Reset`

描述： 重置鼠标连接

输出参数：

参数名	类型	描述
`KeyUsbId`	`U32`	复合设备USB口
`KeyFuncId`	`U32`	功能设备ID
`MouseUsbId`	`U32`	鼠标USBID
`MouseFuncId`	`U32`	鼠标功能设备ID

`Disconnect`

描述： 鼠标断开连接

bmc.kepler.Managers.UsbDevice.LCD

属性

属性名	类型	可读写	信号通知	描述
`ConnectState`	`U32`	只读	变更广播	设备连接状态

方法

`Connect`

描述： LCD设备建立连接

`Disconnect`

描述： LCD设备断开连接

bmc.kepler.Managers.UsbDevice.Ums

属性

属性名	类型	可读写	信号通知	描述
`ConnectState`	`U32`	只读	变更广播	连接状态,未连接为0,连接为1
`Enabled`	`Boolean`	读写	变更广播	u盘使能标志

方法

`Connect`

描述： u盘建立连接

输入参数：

参数名	类型	描述
`FlashDev`	`String`	u盘设备名称

输出参数：

参数名	类型	描述
`UsbId`	`U32`	复合设备USB口
`FuncId`	`U32`	功能设备ID

`Disconnect`

描述： u盘断开连接

bmc.kepler.Managers.VirtualMedia.CD

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	读写	变更广播	虚拟媒体ID
`ConnectedVia`	`String`	读写	变更广播	虚拟媒体连接途径
`Image`	`String`	读写	变更广播	远程镜像URI
`ImageName`	`String`	读写	变更广播	远程镜像文件名
`MediaTypes`	`String[]`	读写	变更广播	虚拟媒体类型
`ConnectNum`	`U8`	读写	变更广播	虚拟媒体连接数量
`ConnectState`	`U8`	读写	变更广播	虚拟媒体连接状态

方法

`InsertMedia`

描述： 插入媒体

输入参数：

参数名	类型	描述
`Image`	`String`	镜像URI

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务标识

`EjectMedia`

描述： 弹出媒体

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务标识

bmc.kepler.Managers.VncService

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	读写	变更广播	VNC服务Id
`SSLEncryptionEnabled`	`Boolean`	只读	变更广播	ssl加密使能
`KeyboardLayout`	`String`	只读	变更广播	键盘模式,取值: en:美式键盘, jp:日式键盘, de:德式键盘

方法

`SetSSLEncryptionEnabled`

描述： 设置ssl加密使能

输入参数：

参数名	类型	描述
`Enabled`	`Boolean`	是/否

`SetKeyboardLayout`

描述： 设置键盘布局

输入参数：

参数名	类型	描述
`Enabled`	`String`	VNC键盘布局

bmc.kepler.Manufacture

属性

属性名	类型	可读写	信号通知	描述
`Type`	`U8`	只读	变更广播	装备测试项类型，1人工自检，2需要人工准备前置条件，3拷机测试，4人工检查结果，5人工操作测试，6与装备交互测试
`Id`	`U8`	只读	变更广播	装备测试项id
`Slot`	`U32`	只读	变更广播	槽位号
`DeviceNum`	`U8`	只读	变更广播	设备id
`Param`	`U8[]`	读写	变更广播	测试项传入的参数
`ItemName`	`String`	只读	变更广播	设备名称
`PrompteReady`	`String`	只读	变更广播	测试前交互提示
`PrompteFinish`	`String`	只读	变更广播	测试完成交互提示
`ProcessPeriod`	`U16`	只读	变更广播	测试所需时间
`Status`	`String`	只读	变更广播	当前测试状态

方法

`Start`

描述： 开始装备测试项

`Stop`

描述： 停止装备测试项

`GetResult`

描述： 获取装备测试项结果

输出参数：

参数名	类型	描述
`Status`	`String`	装备测试项状态
`Description`	`String`	装备测试项描述

bmc.kepler.Manufacture.Extension

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U16`	只读	变更广播	Multihost环境下system编号

bmc.kepler.Manufacture.Simulate

属性

属性名	类型	可读写	信号通知	描述
`VrdUpgradeSimulated`	`U8`	读写	变更广播	模拟VRD升级功能(0:正常升级，1：模拟升级)

bmc.kepler.Manufacture.Status

属性

属性名	类型	可读写	信号通知	描述
`Mode`	`U8`	只读	变更广播	装备模式：0表示ft阶段，1表示st阶段或者正常运行阶段
`Enabled`	`Boolean`	只读	变更广播	装备使能：false表示未使能，true表示使能

bmc.kepler.Mdb

方法

`GetObject`

描述： 根据Path, Interfaces查找service与Interface的映射关系

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`Interfaces`	`String[]`	资源树对象路径下的接口

输出参数：

参数名	类型	描述
`Object`	`Object`	返回service与Interface的映射关系

`GetSubObjects`

描述： 根据Path, Depth, Interfaces查找Path、service与Interface的映射关系

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`Depth`	`S32`	指定查找的资源树深度
`Interfaces`	`String[]`	资源树对象路径下的接口数组

输出参数：

参数名	类型	描述
`SubObjects`	`Objects`	返回Path、service与Interface的映射关系

`GetSubPaths`

描述： 根据Path, Depth, Interfaces查找所有满足条件的资源树路径

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`Depth`	`S32`	指定查找的资源树深度
`Interfaces`	`String[]`	资源树对象路径下的接口

输出参数：

参数名	类型	描述
`SubPaths`	`String[]`	返回所有满足条件的资源树路径

`GetParentObjects`

描述： 根据Path, Interfaces查找所有该Path的祖先Path

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`Interfaces`	`String[]`	资源树对象路径下的接口

输出参数：

参数名	类型	描述
`ParentObjects`	`Objects`	返回所有的祖先资源树对象路径

`GetServiceName`

描述： 根据dbus的发送方查找服务名称

输入参数：

参数名	类型	描述
`Sender`	`String`	dbus通信服务的发送方

输出参数：

参数名	类型	描述
`ServiceName`	`String`	返回服务名称

`GetServiceNames`

描述： 查找所有的服务

输出参数：

参数名	类型	描述
`ServiceNames`	`String[]`	返回查找到的所有服务

`GetPath`

描述： 根据Interface下的属性值查找满足条件的资源树对象路径

输入参数：

参数名	类型	描述
`Interface`	`String`	资源树对象路径下的接口
`Filter`	`String`	属性名属性值键值对的json字符串
`IgnoreCase`	`Boolean`	支持忽略属性值大小写

输出参数：

参数名	类型	描述
`Path`	`String`	返回满足查找条件且按字典序排序的第一个资源树对象路径
`Service`	`String`	返回所在的服务名称

`GetInterfaceOwners`

描述： 查询拥有该接口的发送方和资源树对象路径

输入参数：

参数名	类型	描述
`Interface`	`String`	资源树对象路径下的接口

输出参数：

参数名	类型	描述
`InterfaceOwners`	`Array`	返回给定查询接口的拥有者

`IsValidPath`

描述： 根据Path、Ignore_case, 判断是否要忽略大小写来判断路径是否是一个有效路径

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`IgnoreCase`	`Boolean`	支持忽略大小写进行判断

输出参数：

参数名	类型	描述
`Result`	`Boolean`	返回true表示是一个有效路径，false表示无效路径

`GetSubPathsPaging`

描述： 分页查找, 根据Path、Depth、Interfaces查找所有满足条件的资源树路径

输入参数：

参数名	类型	描述
`Path`	`String`	资源树对象路径
`Depth`	`S32`	指定查找的资源树深度
`Interfaces`	`String[]`	资源树对象路径下的接口
`Skip`	`S32`	skip如果传负数等效于skip传0
`Top`	`S32`	top传负数会取skip之后的所有数据

输出参数：

参数名	类型	描述
`Paths`	`String[]`	返回满足查找条件的资源树对象路径

`GetClasses`

描述： 获取服务下的所有类名

输入参数：

参数名	类型	描述
`Service`	`String`	服务名称

输出参数：

参数名	类型	描述
`ClassNames`	`String[]`	对应服务下的所有类名

`GetObjectList`

描述： 根据类名查询对象名、服务名和资源树对象路径

输入参数：

参数名	类型	描述
`ClassName`	`String`	服务下的类名

输出参数：

参数名	类型	描述
`ObjectList`	`Array`	对应类名的对象信息

`GetObjectOwner`

描述： 根据对象名查找服务和资源树对象路径

输入参数：

参数名	类型	描述
`ObjectName`	`String`	对象名

输出参数：

参数名	类型	描述
`ObjectOwners`	`Array`	返回对象的拥有者信息

`GetMatchedObjects`

描述： 根据服务名和接口模式字符串查找对象名、资源树对象路径、接口

输入参数：

参数名	类型	描述
`ObjectName`	`String`	对象名称
`InterfacePattern`	`String`	资源树对象路径下的接口模式字符串

输出参数：

参数名	类型	描述
`MatchedObjects`	`Array`	返回满足查找条件的对象信息

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String[]

Objects 结构：

字段名	类型	描述
key	String
value	Object

InterfaceOwner 结构：

字段名	类型	描述
Sender	String
Path	String

ObjectInfo 结构：

字段名	类型	描述
ObjectName	String
ObjectOwners	Array

ObjectOwner 结构：

字段名	类型	描述
Service	String
Path	String

MatchedObject 结构：

字段名	类型	描述
ObjectName	String
Path	String
Interfaces	String[]

bmc.kepler.Metric

方法

`GetData`

描述： 根据MetricName获取采集项数据

输入参数：

参数名	类型	描述
`MetricName`	`String[]`	采集项名称

输出参数：

参数名	类型	描述
`Val`	`Array`	采集项数据

`GetItems`

描述： 获取采集项描述信息

输出参数：

参数名	类型	描述
`Component`	`String`	采集主体名称
`Classification`	`Array`	分类信息
`Identification`	`Array`	标识信息
`MetricName`	`String[]`	采集项名称

`SynDataAcquisitionEnable`

描述： 将数据采集开关同步到业务组件

输入参数：

参数名	类型	描述
`Enabled`	`U8`	数据采集开关

自定义类型

DataCollectionItem 结构：

字段名	类型	描述
MetricName	String	采集项名称
Data	String[]	采集项数据点

TagProp 结构：

字段名	类型	描述
PropName	String	采集主体属性名
PropVal	String	采集主体属性值

bmc.kepler.MicroComponent

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	组件名称
`Version`	`String`	只读	变更广播	组件版本号
`Author`	`String`	只读	变更广播	组件作者
`License`	`String`	只读	变更广播	组件证书
`Pid`	`S32`	只读	变更广播	组件pid
`Description`	`String`	只读	变更广播	组件的描述信息
`Status`	`String`	只读	变更广播	组件状态

方法

`HealthCheck`

描述： 检查组件健康状态的接口

输出参数：

参数名	类型	描述
`Status`	`S32`	返回组件健康状态结果，正常返回0，检查失败后立即重启返回-2，其它异常情况返回-1

bmc.kepler.MicroComponent.ConfigManage

方法

`Backup`

描述： 配置文件备份

输入参数：

参数名	类型	描述
`FilePath`	`String`	配置文件打包路径

输出参数：

参数名	类型	描述
`List`	`Array`	导出的配置文件名称、路径列表

`Export`

描述： 根据请求参数导出组件配置数据

输入参数：

参数名	类型	描述
`Type`	`String`	custom: 业务导出; configuration: 定制导出

输出参数：

参数名	类型	描述
`Data`	`String`	组件配置数据（json字符串形式）

`Import`

描述： 根据请求参数导入组件配置数据

输入参数：

参数名	类型	描述
`Data`	`String`	组件配置数据（json字符串形式）
`Type`	`String`	custom: 业务导入; configuration: 定制导入

`Recover`

描述： 配置文件还原

输入参数：

参数名	类型	描述
`PreserveList`	`Object`	保留日志的列表

`Verify`

描述： 校验组件自定义定制化结果

输入参数：

参数名	类型	描述
`Data`	`String`	组件配置数据(json字符串形式)

输出参数：

参数名	类型	描述
`Result`	`String`	组件自定义校验结果(json字符串形式)

`GetTrustedConfig`

描述： 获取供应链相关组件安全配置信息json字符串

输出参数：

参数名	类型	描述
`Configuration`	`String`	供应链相关组件安全配置信息json字符串

`GetPreservedConfig`

描述： 获取还原时需要保留的配置信息

输入参数：

参数名	类型	描述
`PreserveFlag`	`Preserve`	保留配置标志，用于标识需要保留哪些配置信息

输出参数：

参数名	类型	描述
`PreserveData`	`String`	保留配置数据json字符串

自定义类型

Items 结构：

字段名	类型	描述
FileName	String
OriginPath	String

Object 结构：

字段名	类型	描述
key	String
value	String

Preserve 结构：

字段名	类型	描述
PreserveKey	String
PreserveValue	String

bmc.kepler.MicroComponent.Debug

属性

属性名	类型	可读写	信号通知	描述
`DlogLevel`	`String`	只读	变更广播	组件的日志等级
`DlogType`	`String`	读写	变更广播	组件的日志类型

方法

`Dump`

描述： 用于导出组件日志到指定路径

输入参数：

参数名	类型	描述
`FilePath`	`String`	日志文件导出的路径

`SetDlogLevel`

描述： 设置组件的日志级别（生效时长是以小时为单位，范围是1-24，作用是在修改的日志级别小于默认级别时，在到生效时长后，改回默认级别）

输入参数：

参数名	类型	描述
`Level`	`String`	设置的日志级别
`EffectiveHours`	`U8`	日志级别，生效时长

`AttachDebugConsole`

描述： 使mdbctl和业务组件建立连接

输入参数：

参数名	类型	描述
`Port`	`U32`	mdbctl分配的端口号

`DetachDebugConsole`

描述： 使mdbctl和业务组件断开连接

bmc.kepler.MicroComponent.Performance

方法

`StartProfiling`

描述： 开始统计组件的signal接收，rpc调用信息

输入参数：

参数名	类型	描述
`Duration`	`U32`	统计时长

bmc.kepler.MicroComponent.Reboot

方法

`Prepare`

描述： 用于业务组件重启准备

输出参数：

参数名	类型	描述
`Result`	`S32`	int32, 返回业务组件重启准备结果, SUCCESS(0),FAIL(-1)

`Action`

描述： 重启前执行资源回收、数据存盘等操作

输出参数：

参数名	类型	描述
`Result`	`S32`	int32,返回业务组件资源回收、数据存盘等处理结果, SUCCESS(0),FAIL(-1)

`Cancel`

描述： 取消重启

bmc.kepler.MicroComponent.Snapshot

方法

`StartSnapshot`

描述： 收集组件snapshot，并保存到文件

输出参数：

参数名	类型	描述
`Result`	`String`	返回结果消息，包括保存路径

`DiffSnapshot`

描述： 收集组件snapshot，将与上一次snapshot接口比较的结果保存到文件

输出参数：

参数名	类型	描述
`Result`	`String`	返回结果消息，包括保存路径

bmc.kepler.Mux.I2cMux

bmc.kepler.Object.Properties

属性

属性名	类型	可读写	信号通知	描述
`ClassName`	`String`	只读	变更广播	对象类名
`ObjectName`	`String`	只读	变更广播	对象名
`ObjectIdentifier`	`Struct`	只读	变更广播	对象标志符

方法

`GetOptions`

描述： 按接口名和属性名查询属性的能力选项

输入参数：

参数名	类型	描述
`Interface`	`String`	接口名
`Property`	`String`	属性名

输出参数：

参数名	类型	描述
`Options`	`Struct`	属性能力选项，例如是否弃用、是否是易变属性等

`GetPropertiesByOptions`

描述： 按接口名和能力选项查询符合条件的所有属性

输入参数：

参数名	类型	描述
`Interface`	`String`	接口名
`Options`	`Struct`	属性能力选项，例如是否弃用、是否是易变属性等

输出参数：

参数名	类型	描述
`Properties`	`String[]`	属性名列表

自定义类型

StructIdentifier 结构：

字段名	类型	描述
SystemId	U8
ManagerId	String
ChassisId	String
Position	String

Options 结构：

字段名	类型	描述
volatile	Boolean
deprecated	Boolean
explicit	Boolean
emitsChangedSignal	String

bmc.kepler.ObjectGroup

属性

属性名	类型	可读写	信号通知	描述
`Position`	`String`	只读	变更广播	对象组位置
`Owners`	`String[]`	只读	变更广播	对象组所有者
`OnlineTimestamp`	`U64`	只读	变更广播	用于描述对象组上树时刻, 框架对对象组按上树时间升序排序, 组件启动后按顺序获取对象组。属性来源为tick数, 单位:ms。
`Slot`	`U8`	只读	变更广播	对象组对应的槽位号

方法

`GetObjects`

描述： 获取此位置的所有owner的对象

输入参数：

参数名	类型	描述
`Owner`	`String`	对象所有者App名称

输出参数：

参数名	类型	描述
`Position`	`String`	组件的position
`Objects`	`Array`	组件此position所有对象的信息（类名，对象名，对象属性，拓展属性）
`LifeCycleId`	`U32`	组件对象生命周期id标志

`GetTopology`

描述： 获取对象组拓扑信息

输出参数：

参数名	类型	描述
`Topology`	`String`	对象组拓扑信息

自定义类型

ObjectInfo 结构：

字段名	类型	描述
ClassName	String
ObjectName	String
ObjectProps	String
ObjectExtends	String

bmc.kepler.Persistence

方法

`HasTableHistoryRecord`

描述： 查询表格是否曾经存在过

输入参数：

参数名	类型	描述
`TableName`	`String`	查询的表面

输出参数：

参数名	类型	描述
`Result`	`Boolean`	查询的结果

bmc.kepler.ProductInfo.FruCtrlCapabilities

属性

属性名	类型	可读写	信号通知	描述
`GlobalDomainSupported`	`Boolean`	只读	变更广播	是否支持对全域进行上下电操作，支持true，不支持false
`MultihostSupported`	`Boolean`	只读	变更广播	是否支持multihost，支持true，不支持false

bmc.kepler.Redfish.Task

方法

`GetTaskId`

描述： 获取Redfish任务Id

输入参数：

参数名	类型	描述
`TaskId`	`U32`

输出参数：

参数名	类型	描述
`RedfishTaskId`	`U32`	资源数的任务Id映射的Redfish任务Id, 0表示任务不存在

bmc.kepler.Release.MonitorControl

方法

`SetMonitorStatus`

描述： 用于开启或关闭指定的检查机制的命令, 包括组件启动状态检查、组件运行状态检查、组件在线状态检查

输入参数：

参数名	类型	描述
`Type`	`String`	表示使能的检查机制类型, 参数选择包括:starting(启动状态检查), running(运行状态检查), online(组件在线状态检查)
`Enabled`	`Boolean`	开启或关闭检查机制的开关, true表示开启, false表示关闭

输出参数：

参数名	类型	描述
`Result`	`S32`	表示使能检查机制启停的结果, 0代表成功, -1代表失败

bmc.kepler.Release.TraceChip

方法

`TraceChip`

描述： 控制芯片对象的实时数据跟踪。start：开始跟踪，stop：停止跟踪

输入参数：

参数名	类型	描述
`Action`	`String`	trace动作，start：跟踪芯片对象的读写数据，stop：停止跟踪芯片对象的读写数据

bmc.kepler.Scanner

属性

属性名	类型	可读写	信号通知	描述
`Value`	`U64`	只读	变更广播	Scanner的值
`Status`	`U8`	只读	变更广播	Scanner状态, 0: 正常获取值, 1: 获取值失败, 2: 获取值预失败,正在进行防抖, 3: 处于无效状态, 4: 初始状态, 暂未开始扫描

bmc.kepler.Scanner.Aggregate

属性

属性名	类型	可读写	信号通知	描述
`AggregateOffset`	`U32`	只读	变更广播	Scanner在汇聚数据中的相对偏移
`AggregateStatus`	`Boolean`	只读	变更广播	Scanner是否从汇聚数据中读取到, 由hwproxy动态设置结果

bmc.kepler.SessionService

属性

属性名	类型	可读写	信号通知	描述
`SessionTimeout`	`U32`	读写	变更广播	会话超时时间(秒)
`SessionMode`	`U32`	读写	变更广播	会话占用模式，0共享模式，1独占模式
`SessionMaxCount`	`U32`	只读	变更广播	最大会话数
`ServiceEnabled`	`Boolean`	只读	变更广播	是否允许创建会话

bmc.kepler.SessionService.Session

属性

属性名	类型	可读写	信号通知	描述
`ClientOriginIPAddress`	`String`	只读	变更广播	客户端ip
`CreatedTime`	`String`	只读	变更广播	会话创建时间
`SessionId`	`String`	只读	变更广播	会话Id
`OemSessionType`	`S8`	只读	变更广播	OEM会话类型，包括Sso、web、内部redfish会话类型等
`AccountPassword`	`String`	只读	变更广播	适配redifsh标准，实际未上树，默认null
`SessionType`	`String`	只读	变更广播	会话类型，包括GUI、Redfish、CLI等
`UserName`	`String`	只读	变更广播	登录用户名
`LastLoginIp`	`String`	只读	变更广播	上次登录ip
`LastLoginTime`	`String`	只读	变更广播	上次登录时间
`AuthType`	`S8`	只读	变更广播	认证类型，包括本地认证、远程认证等
`Role`	`String[]`	只读	变更广播	用户角色，包括管理员、操作员等
`Privileges`	`String[]`	只读	变更广播	会话拥有的九大权限
`AccountId`	`String`	只读	变更广播	登录用户id
`BrowserType`	`U8`	只读	变更广播	浏览器类型

方法

`SessionDelete`

输入参数：

参数名	类型	描述
`LogoutType`	`U8`	会话退出类型

bmc.kepler.SessionService.Sessions

属性

属性名	类型	可读写	信号通知	描述
`ValidateSsoClient`	`Boolean`	读写	变更广播	SSO登录ip校验使能开关

方法

`NewSession`

输入参数：

参数名	类型	描述
`UserName`	`String`
`Password`	`U8[]`
`SessionType`	`U8`
`Domain`	`String`
`Ip`	`String`
`ExtraData`	`ExtraDataDict`

输出参数：

参数名	类型	描述
`Token`	`String`
`CsrfToken`	`String`
`SessionId`	`String`

`NewRemoteConsoleSession`

输入参数：

参数名	类型	描述
`Token`	`String`
`SessionType`	`U8`
`SessionMode`	`U8`

输出参数：

参数名	类型	描述
`RemoteConsoleToken`	`String`
`RemoteConsoleSessionId`	`String`

`NewVNCSession`

输入参数：

参数名	类型	描述
`CipherText`	`String`
`AuthChallenge`	`String`
`SessionMode`	`U8`

输出参数：

参数名	类型	描述
`VNCSessionId`	`String`

`ValidateSessionWithCsrf`

输入参数：

参数名	类型	描述
`SessionType`	`U8`
`Token`	`String`
`CsrfToken`	`String`

输出参数：

参数名	类型	描述
`SessionId`	`String`

`ValidateSession`

输入参数：

参数名	类型	描述
`SessionType`	`U8`
`Token`	`String`

输出参数：

参数名	类型	描述
`SessionId`	`String`

`GetSessionLogoutType`

输入参数：

参数名	类型	描述
`SessionId`	`String`

输出参数：

参数名	类型	描述
`LogoutType`	`U8`

`SessionHeartBeat`

输入参数：

参数名	类型	描述
`SessionId`	`String`
`RemainActiveSeconds`	`U8`

`GetCLISessionList`

输出参数：

参数名	类型	描述
`CLISessions`	`Array`

`NewSessionBySSO`

描述： 通过SSOToken创建会话

输入参数：

参数名	类型	描述
`Token`	`String`
`SessionType`	`U8`
`SessionMode`	`U8`

输出参数：

参数名	类型	描述
`Token`	`String`
`CsrfToken`	`String`
`SessionId`	`String`

`SetKvmKey`

描述： 设置KVM直连凭证

输入参数：

参数名	类型	描述
`SecretKey`	`String`
`SessionMode`	`U8`

`DeleteAllSessions`

描述： 删除对应类型的所有会话

输入参数：

参数名	类型	描述
`SessionType`	`U8`
`SessionLogoutType`	`U8`

`NewSessionByCert`

描述： 双因素认证创建会话

输入参数：

参数名	类型	描述
`SerialNumber`	`String`
`Issuer`	`String`
`Subject`	`String`
`Ip`	`String`
`BrowserType`	`U8`

输出参数：

参数名	类型	描述
`Token`	`String`
`CsrfToken`	`String`
`SessionId`	`String`

自定义类型

CLISession 结构：

字段名	类型	描述
SessionId	String
Username	String
Ip	String
LoginTimeStr	String
Privilege	String[]
SessionType	String

OccupationMode 枚举：

字段名	类型	数值
Shared	Enum	0
Exclusive	Enum	1

ExtraDataDict 结构：

字段名	类型	描述
key	String
value	String

SessionType 枚举：

字段名	类型	数值
GUI	Enum	0
Redfish	Enum	1
CLI	Enum	2
SSO	Enum	3
KVM	Enum	4
VNC	Enum	5
KVM_VMM	Enum	6
VIDEO	Enum	7
ALL	Enum	255

bmc.kepler.SystemControl

方法

`ForceReset`

描述： 强制复位BMC的接口

输入参数：

参数名	类型	描述
`ResetType`	`U8`	重启类型0:表示下次从正常系统启动,1:表示下次从最小系统启动

`GracefulReset`

描述： 平滑复位BMC的接口

输入参数：

参数名	类型	描述
`ResetType`	`U8`	重启类型0:表示下次从正常系统启动,1:表示下次从最小系统启动

输出参数：

参数名	类型	描述
`OutData`	`S32`	返回业务组件善后处理的结果

bmc.kepler.Systems.BIOSConfiguration

属性

属性名	类型	可读写	信号通知	描述
`DEMTEnabled`	`Boolean`	只读	变更广播	DEMT功能是否开启
`RefreshRate`	`U32`	只读	变更广播	内存刷新频率

方法

`SetDEMTEnabled`

描述： 设置DEMT功能是否开启

输入参数：

参数名	类型	描述
`DEMTEnabled`	`Boolean`	DEMT功能是否开启

`SetRefreshRate`

描述： 设置内存刷新频率

输入参数：

参数名	类型	描述
`RefreshRate`	`U32`	内存刷新频率

bmc.kepler.Systems.Bios

属性

属性名	类型	可读写	信号通知	描述
`SystemStartupState`	`U8`	只读	变更广播	Bios启动状态
`SystemId`	`U8`	只读	变更广播	系统Id
`Version`	`String`	只读	变更广播	Bios版本信息
`BackupVersion`	`String`	只读	变更广播	Bios备份版本信息
`CurrentValueFileName`	`String`	只读	变更广播	当前生效的配置文件
`ResultFileName`	`String`	只读	变更广播	配置生效结果文件
`SettingFileName`	`String`	只读	变更广播	待生效配置文件
`RegistryFileName`	`String`	只读	变更广播	标准配置文件
`MenuData`	`String`	只读	变更广播	菜单数据
`MenuChangeFlag`	`U8`	只读	变更广播	菜单变动标志
`RegistryVersion`	`String`	只读	变更广播	标准配置文件的版本
`DEMTConfig`	`U8`	只读	变更广播	DEMT配置
`PcieCardBDF`	`U8[]`	只读	变更广播	Pcie卡BDF
`PcieDiskBDF`	`U8[]`	只读	变更广播	硬盘BDF
`OCPCardBDF`	`U8[]`	只读	变更广播	OCP卡BDF
`BiosBootStage`	`U8`	只读	变更广播	Bios启动阶段
`UpgradeFailed`	`U8`	只读	变更广播	正常升级完成后,BIOS Flash完整性校验状态,主要用于配置告警
`RecoverFailed`	`U8`	只读	变更广播	自恢复完成后,BIOS Flash完整性校验状态,主要用于配置告警
`BiosLogPrintEnabled`	`U8`	只读	变更广播	Bios的日志全打印使能状态
`SettingsEffectiveStatus`	`String`	只读	变更广播	Bios配置文件的生效状态
`BiosConfigActiveMode`	`U64`	只读	变更广播	设置BIOS配置导入的生效模式, 0：导入BIOS待生效配置，BIOS重启后生效 1：恢复BIOS默认配置，再导入BIOS待生效配置，BIOS重启后生效
`TeeOSVersion`	`String`	只读	变更广播	TeeOS版本号
`ResetBiosToDefaultsPending`	`Boolean`	只读	变更广播	恢复默认命令下发但还没生效，true：表示存在（即未生效），false：表示不存在（即已生效）

方法

`ClearCmos`

描述： 清除BIOS配置信息

输出参数：

参数名	类型	描述
`Result`	`S32`	清除BIOS配置结果

`SetBiosConfigActiveMode`

描述： 设置BIOS配置导入的生效模式

输入参数：

参数名	类型	描述
`Mode`	`U64`	BIOS配置生效模式, 0：导入BIOS待生效配置，BIOS重启后生效 1：恢复BIOS默认配置，再导入BIOS待生效配置，BIOS重启后生效

`ResetSetupConfig`

描述： 清除BIOS配置以及待生效配置

输出参数：

参数名	类型	描述
`Result`	`S32`	清除BIOS配置以及待生效配置结果

`ChangePassword`

描述： 修改BIOS密码

输入参数：

参数名	类型	描述
`PasswordType`	`String`	密码类型
`OldPassword`	`String`	旧密码
`NewPassword`	`String`	新密码

输出参数：

参数名	类型	描述
`Result`	`S32`	修改结果，失败：-1，成功:0

`SetBiosLogEnabled`

描述： 设置BIOS日志全打印开关

输入参数：

参数名	类型	描述
`BiosLogPrintEnabled`	`U8`	BIOS全打印开关

输出参数：

参数名	类型	描述
`Result`	`S32`	设置BIOS全打印开关结果

`ExportBiosSetup`

描述： 导出Bios的配置

输入参数：

参数名	类型	描述
`FileType`	`String`	导出文件类型：Registry、CurrentValue、Setting、Result、ConfigValue

输出参数：

参数名	类型	描述
`Result`	`String`	导出Bios的配置结果

`ImportBiosSetup`

描述： 导入Bios配置

输入参数：

参数名	类型	描述
`FileType`	`String`	导入文件类型：Registry、CurrentValue、Setting、Result、ConfigValue
`Content`	`String`	导入文件内容

输出参数：

参数名	类型	描述
`Result`	`S32`	导入Bios配置结果

`GetCurrentValueSetting`

描述： 获取属性（参数ReqKey）当前配置的值

输入参数：

参数名	类型	描述
`ReqKey`	`String`	属性名

输出参数：

参数名	类型	描述
`RespValue`	`String`	属性当前配置的值

`RemoveCachedSettings`

描述： 清除待生效的配置

输出参数：

参数名	类型	描述
`Result`	`S32`	清除待生效的配置的结果

bmc.kepler.Systems.BiosUpgradeService

属性

属性名	类型	可读写	信号通知	描述
`ActivatedStatus`	`U8`	只读	变更广播	Bios无感升级固件生效状态, 枚举值0/1/2, 0:生效完成; 1:待生效; 2:生效中
`FirmwareEffectiveStatus`	`U8`	只读	变更广播	Bios普通升级固件生效状态, 枚举值1/2/3, 1:(待生效)固件待写入flash; 2:(生效中)固件已写入flash,待生效; 3:(生效完成)固件已写入flash,且已生效,包含无升级任务

方法

`ActivateFirmware`

描述： 生效Bios固件

输入参数：

参数名	类型	描述
`DatabseType`	`String[]`	Bios固件名：imu、imp等

`GetFirmwareInfo`

描述： 获取Bios固件信息

输出参数：

参数名	类型	描述
`FirmwareInfo`	`String`	Bios固件信息

`ExportBiosFirmware`

描述： 导出Bios固件信息

输出参数：

参数名	类型	描述
`TaskId`	`U32`	返回任务Id

bmc.kepler.Systems.BizTopoNode

属性

属性名	类型	可读写	信号通知	描述
`SystemID`	`U8`	只读	变更广播	系统Id

bmc.kepler.Systems.Board

属性

属性名	类型	可读写	信号通知	描述
`Slot`	`U8`	只读	变更广播	槽位号
`Number`	`U8`	只读	变更广播	逻辑编号
`Position`	`String`	只读	变更广播	容器信息(如:chassis)
`Name`	`String`	只读	变更广播	单板名
`ProductName`	`String`	只读	变更广播	产品名
`SilkText`	`String`	只读	变更广播	丝印信息
`Manufacturer`	`String`	只读	变更广播	厂商
`Description`	`String`	只读	变更广播	单板描述
`BoardID`	`U16`	只读	变更广播	单板ID
`PartNumber`	`String`	只读	变更广播	部件编码
`PcbVersion`	`String`	只读	变更广播	PCB版本号
`LogicVersion`	`String`	只读	变更广播	逻辑版本号(cpld)
`SRVersion`	`String`	只读	变更广播	SR版本号
`MCUVersion`	`String`	只读	变更广播	MCU版本号
`PSIPVersion`	`String`	只读	变更广播	封装电源版本号
`LogicUnit`	`U32`	只读	变更广播	逻辑位号(U位号)
`PowerWatts`	`U32`	只读	变更广播	功率
`RunningStatus`	`U8`	只读	变更广播	监控cpld和mcu的运行状态(1:正常运行,0:异常)
`FruID`	`U8`	只读	变更广播	关联Fru对象的FruID属性
`NodeId`	`String`	只读	变更广播	资源id,优先遵循v2中redfish的计算规则,这里由容器信息Position和设备丝印名称DeviceName拼接而成,如:chassisPCIeRiser1
`DeviceName`	`String`	只读	变更广播	板卡丝印信息(如:PCIe Riser1)
`BoardType`	`String`	只读	变更广播	单板类型
`RefComponent`	`String`	只读	变更广播	引用到Component对象
`RefFru`	`String`	只读	变更广播	引用到Fru对象
`SerialNumber`	`String`	只读	变更广播	序列号
`CpldStatus`	`U8`	只读	变更广播	Cpld状态
`MultiLogicUnit`	`LogicUnitObject`	只读	变更广播	单板所有逻辑位号,key:cpld名,value:逻辑位号
`MultiLogicVersion`	`LogicVerObject`	只读	变更广播	单板所有逻辑版本号,key:cpld名,value:逻辑版本号

自定义类型

LogicUnitObject 结构：

字段名	类型	描述
key	String
value	U32

LogicVerObject 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.Board.CpuBoard

属性

属性名	类型	可读写	信号通知	描述
`Platform`	`U8`	只读	变更广播	平台类型
`BIOSVersion`	`String`	只读	变更广播	BIOS版本号，一host对应多个bcu的场景下只有主bcu显示

bmc.kepler.Systems.Board.M2

属性

属性名	类型	可读写	信号通知	描述
`M2SlotPresence`	`U8`	只读	变更广播	M.2盘在位情况,每个bit表示一个槽位,bit0表示SSD1在位,bit1表示SSD2在位
`M2SlotMaxCount`	`U8`	只读	变更广播	M.2盘的上限

bmc.kepler.Systems.Board.NpuBoard

属性

属性名	类型	可读写	信号通知	描述
`PowerWatts`	`U16`	只读	变更广播	NPU模组功耗值，单位W
`PowerCapWatts`	`U16`	只读	变更广播	NPU模组功耗封顶值，单位W
`MaxPowerCapWatts`	`U16`	只读	变更广播	NPU模组支持的最大功耗封顶值，单位W
`MinPowerCapWatts`	`U16`	只读	变更广播	NPU模组支持的最小功耗封顶值，单位W
`Model`	`String`	只读	变更广播	NPU模组型号
`ComputeCapability`	`String`	只读	变更广播	NPU模组的算力

方法

`Reset`

描述： 复位DPU卡

输入参数：

参数名	类型	描述
`Slot`	`U32`	槽位号

bmc.kepler.Systems.Board.NpuBoards

方法

`SetNpuPowerCap`

描述： 设置NPU封顶功耗

输入参数：

参数名	类型	描述
`PowerCapConfigs`	`Array`	设置NPU封顶功耗参数列表

输出参数：

参数名	类型	描述
`FailedList`	`U8[]`	设置失败的NPU模组Id数组

自定义类型

PowerCapConfigsItem 结构：

字段名	类型	描述
NpuId	U8	NPU模组Id
Power	S16	封顶功耗调整幅度，正数表示上调，负数表示下调

bmc.kepler.Systems.Board.Unit

属性

属性名	类型	可读写	信号通知	描述
`UID`	`String`	只读	变更广播	组件唯一标识
`Type`	`String`	只读	变更广播	组件类型(枚举值:EXU,BCU,SEU,CLU,SEU)
`HWSRVersion`	`String`	只读	变更广播	天池组件Eeprom中的sr版本号
`CurrentUpgradeStatus`	`U8`	只读	变更广播	0表示未在升级，1:mcu正在升级，2cpld正在升级

bmc.kepler.Systems.BootOptions

属性

属性名	类型	可读写	信号通知	描述
`BootSourceOverrideMode`	`String`	只读	变更广播	系统启动模式，Legacy或UEFI
`BootSourceOverrideEnabled`	`String`	只读	变更广播	系统启动项生效次数:Disabled不生效,Once生效一次,Continuos一直生效
`BootSourceOverrideTarget`	`String`	只读	变更广播	系统启动项
`BootOptionReference`	`String[]`	只读	变更广播	唯一启动选项标识符
`BootOrder`	`String[]`	只读	变更广播	系统启动项启动顺序
`BootModeSupport`	`Boolean`	只读	变更广播	BIOS启动模式是否支持设置
`BootModeIpmiSettable`	`Boolean`	只读	变更广播	BIOS启动模式是否支持通过IPMI设置

方法

`ShieldIpmiModifyBootModeSupport`

描述： 屏蔽是否可以通过ipmi设置启动模式

输入参数：

参数名	类型	描述
`ModeSwitch`	`Boolean`	屏蔽启动模式的开关

输出参数：

参数名	类型	描述
`RespCode`	`S32`	屏蔽结果

`ImportCertificate`

描述： 导入Bios的Https启动证书

输入参数：

参数名	类型	描述
`CertString`	`String`	Https启动证书内容
`CertType`	`String`	Https启动证书类型

`ImportCrl`

描述： 导入Bios的Https启动证书吊销列表

输入参数：

参数名	类型	描述
`CertString`	`String`	Https启动吊销证书内容
`CertType`	`String`	Https启动吊销证书类型

`ResetCrl`

描述： 重置Bios的Https启动证书吊销列表

输入参数：

参数名	类型	描述
`ResetType`	`String`	Bios的Https证书吊销类型

`ResetCertificate`

描述： 重置Bios的Https启动证书

输入参数：

参数名	类型	描述
`ResetType`	`String`	Bios的Https启动证书类型

`GetCertificate`

描述： 获取Bios的Https启动证书

输出参数：

参数名	类型	描述
`CertInfo`	`String`	Bios的Https启动证书类型

`SetBootOrder`

描述： 设置Bios启动顺序

输入参数：

参数名	类型	描述
`BootOrderJson`	`String`	Bios启动顺序

输出参数：

参数名	类型	描述
`OutCode`	`S32`	Bios启动顺序返回码
`ErrName`	`String`	Bios启动顺序错误名
`ErrValue`	`String`	Bios启动顺序错误值

`SetStartOption`

描述： 设置Bios启动项

输入参数：

参数名	类型	描述
`StartOption`	`String`	Bios启动项

输出参数：

参数名	类型	描述
`Result`	`S32`	设置Bios启动项结果

`SetStartOptionFlag`

描述： 设置Bios启动项生效次数

输入参数：

参数名	类型	描述
`StartOptionFlag`	`String`	Bios启动项次数

输出参数：

参数名	类型	描述
`Result`	`S32`	设置Bios启动项生效次数

`SetBootMode`

描述： 设置Bios启动模式

输入参数：

参数名	类型	描述
`mode`	`String`	Bios启动模式

输出参数：

参数名	类型	描述
`RespCode`	`S32`	设置Bios启动模式结果

bmc.kepler.Systems.Component

属性

属性名	类型	可读写	信号通知	描述
`FruId`	`U8`	只读	变更广播	关联所在的Fru的Fruid
`Instance`	`U8`	只读	变更广播	组件设备Number
`Type`	`U8`	只读	变更广播	组件类型
`Name`	`String`	读写	变更广播	组件设备名称
`Presence`	`U8`	只读	变更广播	组件在位情况
`Health`	`U8`	读写	变更广播	组件健康状态
`PowerState`	`U8`	只读	变更广播	组件上电状态
`BoardId`	`U16`	只读	变更广播	组件单板BoardId
`UniqueId`	`String`	只读	变更广播	组件唯一标识,Vendor + ComponentID
`Manufacturer`	`String`	只读	变更广播	组件厂商信息
`GroupId`	`U8`	只读	变更广播	组件逻辑组Id
`Location`	`String`	只读	变更广播	组件的容器
`SerialNumber`	`String`	只读	变更广播	组件序列号
`PartNumber`	`String`	只读	变更广播	组件号
`SegmentId`	`U8`	只读	变更广播	组件容器ID
`Function`	`String`	只读	变更广播	部件功能信息
`PreviousSN`	`String`	只读	变更广播	更换前SN,SerialNumber,来自board区域掉电持久化
`ReplaceFlag`	`U8`	只读	变更广播	部件是否发生了更换,用于产生SEL日志
`NodeId`	`String`	只读	变更广播	节点的ID

方法

`UpdateHealth`

描述： 更新组件健康状态

输入参数：

参数名	类型	描述
`Health`	`U8`	健康状态

bmc.kepler.Systems.Components

方法

`GetComponentTypes`

描述： 获取当前存在的所有对象的部件类型

输出参数：

参数名	类型	描述
`ComponentTypes`	`Array`	所有对象的部件类型列表

自定义类型

ComponentTypes 结构：

字段名	类型	描述
ComponentType	U8	部件类型
ComponentName	String	部件名称

bmc.kepler.Systems.ComputerSystem

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	系统Id
`OSVersion`	`String`	只读	变更广播	OS版本号
`KernelVersion`	`String`	只读	变更广播	内核版本号
`HostName`	`String`	读写	变更广播	主机名称
`DomainName`	`String`	只读	变更广播	域名称
`HostDescription`	`String`	只读	变更广播	计算机描述
`MajorOSVersion`	`String`	只读	变更广播	操作系统主版本号
`MinorOSVersion`	`String`	只读	变更广播	操作系统次版本号
`HostnameSyncEnabled`	`Boolean`	读写	变更广播	从带内同步hostname到BMC使能开关默认true

bmc.kepler.Systems.ComputerSystem.Metrics

属性

属性名	类型	可读写	信号通知	描述
`TotalSystemMemoryGiB`	`Double`	只读	变更广播	总系统内存容量
`SystemMemoryBuffersGiB`	`Double`	只读	变更广播	系统内存缓冲区容量
`SystemMemoryCachedGiB`	`Double`	只读	变更广播	系统内存缓存区容量
`NetBandwidthThresholdPercent`	`U16`	读写	变更广播	网络带宽占用率门限默认值100

bmc.kepler.Systems.Contact

属性

属性名	类型	可读写	信号通知	描述
`OfficalWeb`	`String`	读写	变更广播	官网
`SupportWeb`	`String`	读写	变更广播	技术支持网站
`Email`	`String`	读写	变更广播	邮箱
`Phone`	`String`	读写	变更广播	电话
`Copyright`	`String`	读写	变更广播	版权
`KVMClientDownloadLink`	`String`	读写	变更广播	独立kvm客户端下载连接信息
`QRCodeSupported`	`Boolean`	读写	变更广播	Web是否支持显示文档二维码标志位

bmc.kepler.Systems.ContainedPort

属性

属性名	类型	可读写	信号通知	描述
`NodeId`	`String`	只读	变更广播	包含物理网口ID

bmc.kepler.Systems.CoolingArea

属性

属性名	类型	可读写	信号通知	描述
`AreaId`	`U8`	只读	变更广播	调速域Id
`RequirementIdx`	`U8`	只读	变更广播	目标调速策略Id
`PolicyIdxGroup`	`U8[]`	只读	变更广播	线性调速策略Id组
`FanIdxGroup`	`U8[]`	只读	变更广播	调速域风扇组

bmc.kepler.Systems.CoolingConfig

属性

属性名	类型	可读写	信号通知	描述
`SmartCoolingState`	`String`	只读	变更广播	智能调速使能状态
`SmartCoolingMode`	`String`	只读	变更广播	智能调速模式
`Medium`	`String`	只读	变更广播	散热介质（风/液/风液混合）
`CtrlMode`	`String`	只读	变更广播	冷却单元的控制模式（自动/手动/混合）
`TimeOut`	`U32`	只读	变更广播	手动模式下的风扇超时时间
`ManualLevel`	`U8`	只读	变更广播	手动模式下的风扇转速级别
`LevelPercentRange`	`U8[]`	只读	变更广播	手动设置转速级别允许范围
`SensorLocationSupported`	`Boolean`	只读	变更广播	是否支持温度海洋界面显示
`MinAllowedFanSpeedPercent`	`U8`	读写	变更广播	失联状态场景风扇转速级别

方法

`SetSmartCoolingMode`

描述： 设置智能调速模式

输入参数：

参数名	类型	描述
`Mode`	`String`	智能调速模式，取值为：Custom、HighPerformance、LowNoise、EnergySaving或LiquidCooling

`SetMedium`

描述： 设置散热介质类型

输入参数：

参数名	类型	描述
`Medium`	`String`	散热介质类型：Air或Liquid

`SetManualLevel`

描述： 设置手动模式冷却级别

输入参数：

参数名	类型	描述
`UnitId`	`U8`	冷却单元Id
`Level`	`U8`	设置的转速级别

`SetCtrlMode`

描述： 设置冷却单元控制模式

输入参数：

参数名	类型	描述
`CtrlMode`	`String`	冷却单元控制模式
`Timeout`	`U32`	超时时长

`GetCustomTargetTemperatures`

描述： 获取自定义目标温度点

输出参数：

参数名	类型	描述
`CustomTargetTemperatures`	`Array`	自定义目标温度点数组

`GetAbnormalPolicyEffectiveStatus`

描述： 获取异常调速策略生效状态

输入参数：

参数名	类型	描述
`PolicyType`	`String`	异常调速类型, Fan, Pump, Temperature, All

输出参数：

参数名	类型	描述
`EffectiveStatus`	`Boolean`	异常调速策略生效状态, true:触发异常调速, false:未触发异常调速

自定义类型

CustomTargetTemperatureItem 结构：

字段名	类型	描述
TemperatureType	U32	温度点类型 1:Cpu 2:Outlet 3:Disk 4:Memory 5:PCH 6:VRD 7:VDDQ 8:NPUHbm 9:NPUAiCore 10:NPUBoard
TargetTemperatureCelsius	U8	目标调速温度值
MinTargetTemperatureCelsius	U8	目标温度调速温度值的最小值
MaxTargetTemperatureCelsius	U8	目标温度调速温度值的最大值

bmc.kepler.Systems.CoolingFan

属性

属性名	类型	可读写	信号通知	描述
`FanId`	`U8`	只读	变更广播	风扇Id
`HardwarePWM`	`Double`	只读	变更广播	风扇硬件占空比
`FrontPresence`	`U8`	只读	变更广播	前转子在位状态
`RearPresence`	`U8`	只读	变更广播	后转子在位状态
`FrontStatus`	`U8`	只读	变更广播	风扇前转子状态
`RearStatus`	`U8`	只读	变更广播	风扇后转子状态
`FrontSpeed`	`U16`	只读	变更广播	前转子转速
`RearSpeed`	`U16`	只读	变更广播	后转子转速
`Level`	`U8`	只读	变更广播	风扇转速级别

bmc.kepler.Systems.CoolingPolicy

属性

属性名	类型	可读写	信号通知	描述
`PolicyIdx`	`U8`	只读	变更广播	线性调速策略ID
`PolicyType`	`U32`	只读	变更广播	Policy类型，用于标识特定Policy对象
`IsValid`	`U8`	只读	变更广播	策略是否生效，1生效,0不生效
`ExpCondVal`	`String`	只读	变更广播	预期生效条件
`ActualCondVal`	`String`	只读	变更广播	实际生效条件
`CustomSupported`	`Boolean`	只读	变更广播	是否支持自定义调速曲线
`FanSpeedRangePercents`	`U8[]`	只读	变更广播	自定义调速曲线风扇速度范围
`Hysteresis`	`U8`	只读	变更广播	迟滞量
`TemperatureRangeLow`	`S16[]`	只读	变更广播	线性调速策略温度区间左值
`TemperatureRangeHigh`	`S16[]`	只读	变更广播	线性调速策略温度区间右值
`SpeedRangeLow`	`S16[]`	只读	变更广播	线性调速策略转速区间左值
`SpeedRangeHigh`	`S16[]`	只读	变更广播	线性调速策略温度区间右值

方法

`SetCustomCoolingPolicy`

描述： 设置自定义调速策略

输入参数：

参数名	类型	描述
`TemperatureArray`	`U8[]`	温度数组
`FanSpeedArray`	`U8[]`	风扇速度数组

bmc.kepler.Systems.CoolingPump

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U16`	只读	变更广播	泵Id
`Slot`	`U8`	只读	变更广播	泵槽位号
`ActualPWM`	`Double`	只读	变更广播	泵占空比
`Speed`	`U16`	只读	变更广播	泵转速
`Presence`	`U8`	只读	变更广播	泵在位状态
`Status`	`U8`	只读	变更广播	泵状态
`Level`	`U8`	只读	变更广播	手动模式下的转速级别

bmc.kepler.Systems.CoolingRequirement

属性

属性名	类型	可读写	信号通知	描述
`RequirementId`	`U64`	只读	变更广播	目标调速策略Id
`TemperatureType`	`U32`	只读	变更广播	温度点类型
`ActiveInStandby`	`Boolean`	只读	变更广播	Standby下调速是否生效
`TargetTemperatureCelsius`	`U8`	只读	变更广播	目标调速的目标值
`MaxAllowedTemperatureCelsius`	`U8`	只读	变更广播	最大允许的工作温度,即满转温度
`CustomSupported`	`Boolean`	只读	变更广播	是否支持自定义目标温度值
`CustomTargetTemperatureCelsius`	`U8`	只读	变更广播	用户自定义温度值
`TargetTemperatureRangeCelsius`	`U8[]`	只读	变更广播	自定义温度允许范围
`MonitoringStatus`	`U8`	只读	变更广播	温度点状态 0正常 1异常
`MonitoringValue`	`Double`	只读	变更广播	温度点状态
`FailedValue`	`U64`	只读	变更广播	温度点失效调速值
`ThresholdValue`	`U8[]`	只读	变更广播	温度点告警阈值
`AlarmSpeed`	`U8[]`	只读	变更广播	告警调速策略

方法

`SetTargetTemperature`

描述： 自定义目标温度

输入参数：

参数名	类型	描述
`TemperatureCelsius`	`U8`	目标温度值

`SetBackupTemperatureCelsius`

描述： 设置备用温度点温度值

输入参数：

参数名	类型	描述
`TemperatureCelsius`	`Double`	目标温度值

`SetBackupTemperatureStatus`

描述： 设置备用温度点状态

输入参数：

参数名	类型	描述
`Status`	`U8`	目标温度值

bmc.kepler.Systems.DPUCard

属性

属性名	类型	可读写	信号通知	描述
`BootSourceOverrideMode`	`U8`	只读	变更广播	系统启动项0：未设置1：PXE启动2：本地磁盘启动
`PxeOption`	`String`	读写	变更广播	DPU卡的PXE启动选项
`UUID`	`String`	只读	变更广播	DPU卡的UUID
`StorageIpAddr`	`String`	只读	变更广播	存储管理网口IP地址
`StorageIpVlan`	`U16`	只读	变更广播	存储管理网口VlanID
`M2SlotMaxCount`	`U8`	只读	变更广播	M.2卡的上限
`M2SlotPresence`	`U8`	只读	变更广播	M.2卡在位情况，每个bit表示一个槽位
`NetworkAdapterMaxCount`	`U8`	只读	变更广播	网卡最大数量
`NetworkAdapterPresence`	`U8`	只读	变更广播	网卡在位情况，每个bit表示一张
`MCUVersion`	`String`	只读	变更广播	MCU版本号
`SRVersion`	`String`	只读	变更广播	SR版本号
`UID`	`String`	只读	变更广播	组件唯一标识
`PfMacInfo`	`Array`	只读	变更广播	扩展卡的Physical Function Port信息、Physical Function Id信息和永久物理地址信息
`BootSourceOverrideEnabled`	`U8`	只读	变更广播	系统启动固化选项，0：单次生效1：永久生效
`Model`	`String`	只读	变更广播	DPU卡名称，如IT21SHSK
`SystemLoadedStatus`	`U8`	只读	变更广播	DPU卡的OS启动状态
`MRCLogLevel`	`U8`	读写	变更广播	DPU卡BIOS MRC日志等级
`UEFILogLevel`	`U8`	读写	变更广播	DPU卡BIOS UEFI日志等级
`LogicVersion`	`String`	只读	变更广播	Cpld版本
`PowerState`	`String`	只读	变更广播	DPU卡电源状态，On表示上电，Off表示下电
`VrdVersion`	`String`	只读	变更广播	VRD版本号
`MPUBusyStatus`	`U8`	读写	变更广播	MPU繁忙状态 0: 空闲 1: 繁忙
`OSSupported`	`Boolean`	只读	变更广播	用来识别是否开启与OS相关的功能，比如QT100n卡没有诊断中断功能

方法

`SetDpuNmi`

描述： 设置SDI卡诊断中断

输入参数：

参数名	类型	描述
`SlotId`	`U8`	槽位号

`Reset`

描述： 复位DPU卡

`SetPowerState`

描述： 设置DPU电源状态

输入参数：

参数名	类型	描述
`PowerState`	`U8`	DPU电源状态

`SetBootOption`

描述： 设置系统启动项

输入参数：

参数名	类型	描述
`Mode`	`U8`	DPU系统启动项,0:未设置、1:PXE启动、2:本地磁盘启动
`Enabled`	`U8`	DPU系统启动固化选项,0:单次生效、1:永久生效

`ImportPublicKey`

输入参数：

参数名	类型	描述
`Type`	`String`	传入证书方式，URI：文件格式上传，text：字符串格式上传
`Content`	`String`	传入内容，当Type是URI时，传入文件路径，Type是text时，传入证书内容

自定义类型

PfMacInfoItem 结构：

字段名	类型	描述
Port	U16
PfId	U16
PermanentMac	String

bmc.kepler.Systems.DPUCard.Fault

属性

属性名	类型	可读写	信号通知	描述
`HeartBeatLoss`	`U8`	只读	变更广播	是否发生心跳丢失

bmc.kepler.Systems.DPUCard.Metrics

属性

属性名	类型	可读写	信号通知	描述
`CPUTemperatureCelsius`	`S16`	只读	变更广播	SDI卡CPU温度(单位摄氏度，精度为1摄氏度，有小数点则四舍五入。)
`SFP1TemperatureCelsius`	`S16`	只读	变更广播	光模块1温度
`SFP2TemperatureCelsius`	`S16`	只读	变更广播	光模块2温度
`Inlet1TemperatureCelsius`	`S16`	只读	变更广播	计算卡进风口温度
`Outlet1TemperatureCelsius`	`S16`	只读	变更广播	计算卡出风口温度
`PowerWatts`	`U16`	只读	变更广播	功率
`NetworkAdapterChipTemperatureCelsius`	`S16`	只读	变更广播	DPU Nic温度

bmc.kepler.Systems.DPUCard.Processor

属性

属性名	类型	可读写	信号通知	描述
`Architecture`	`String`	只读	变更广播	DPU 的CPU架构
`TotalCores`	`U8`	只读	变更广播	DPU 的CPU核数

bmc.kepler.Systems.DPUCard.System

属性

属性名	类型	可读写	信号通知	描述
`BIOSVersion`	`String`	只读	变更广播	板卡的BIOS版本号
`MemorySizeGiB`	`U16`	只读	变更广播	DPU内存大小
`DiskCapacityGiB`	`U16`	只读	变更广播	DPU存储大小
`SecureBootOptionEnabled`	`Boolean`	读写	变更广播	是否开启安全启动项

bmc.kepler.Systems.DataAcquisitionService

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`U8`	读写	变更广播	数据采集开关使能状态

方法

`GetHistoryData`

描述： 根据Component、MetricType、时间筛选Tag、Metric、DataPoint表信息

输入参数：

参数名	类型	描述
`Component`	`String`	采集主体名称
`MetricType`	`String`	采集类型
`StartTime`	`U64`	开始时间
`EndTime`	`U64`	结束时间

输出参数：

参数名	类型	描述
`Data`	`String`	数据采集信息

`ClearHistoryData`

描述： 清除采集到的数据

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

bmc.kepler.Systems.DelayedPowerOnPolicy

属性

属性名	类型	可读写	信号通知	描述
`Mode`	`String`	读写	变更广播	延迟上电策略
`Seconds`	`Double`	读写	变更广播	延迟上电时间

bmc.kepler.Systems.DiscreteEvent

属性

属性名	类型	可读写	信号通知	描述
`Property`	`U32`	只读	变更广播	离散事件监听的属性，如果监听类型是组合侦听则代表 IPMI SEL产生使用的数据和方向
`EventDir`	`U8`	只读	变更广播	离散事件产生的方向：0 - 恢复；其他 - 产生，当监听类型是独立侦听时使用
`SensorObject`	`String`	只读	变更广播	离散事件关联的离散传感器，当IPMI SEL产生或者恢复时体现在当前传感器的健康状态以及SEL上

bmc.kepler.Systems.DiscreteSensor

属性

属性名	类型	可读写	信号通知	描述
`EntityId`	`U8`	只读	变更广播	传感器对应的实体，来自于IPMI规范，具体需要关联传感器对应的Entity.Id
`EntityInstance`	`U8`	只读	变更广播	传感器对应的实体，来自于IPMI规范，具体需要关联传感器对应的Entity.Instance
`OwnerId`	`U8`	只读	变更广播	传感器归属标识，默认32（归属于BMC），来自于IPMI规范，具体可以参考规范 43.1
`OwnerLun`	`U8`	只读	变更广播	传感器的Lun，默认0，来自于IPMI规范，具体可以参考规范 43.1
`Capabilities`	`U8`	只读	变更广播	传感器支持能力，来自于IPMI规范，具体可以参考规范 43.1
`SensorIdentifier`	`String`	只读	变更广播	传感器标识
`SensorName`	`String`	只读	变更广播	传感器对外显示的名称
`PositiveHysteresis`	`U8`	只读	变更广播	传感器正向迟滞量，来自于IPMI规范，具体可以参考规范 43.1
`NegativeHysteresis`	`U8`	只读	变更广播	传感器负向迟滞量，来自于IPMI规范，具体可以参考规范 43.1
`SensorNumber`	`U8`	只读	变更广播	传感器编号，默认255，来自于IPMI规范，由BMC自行生成；如果需要特殊的编号，则需要单独在传感器定制化进行定制（BMC正常运行时插入的部件的传感器不支持定制）
`Reading`	`U16`	只读	变更广播	传感器原始读值，引用传感器的数据源（如Scanner）读值同步，需要填写一个默认值，用于数据源未更新时显示，需要注意在门限之内，防止产生SEL事件

bmc.kepler.Systems.DiscreteSensorDisplay

属性

属性名	类型	可读写	信号通知	描述
`Status`	`String`	只读	变更广播	传感器当前状态：Enabled：传感器使能；Disabled：传感器禁用；InTest：传感器测试中；Starting：传感器更新中
`Health`	`String`	只读	变更广播	传感器健康状态：Critical：紧急；Major：严重；Minor：一般；OK：正常
`AssertStatus`	`U16`	只读	变更广播	传感器SEL事件状态，bit0 - bit14依次对应15种offset的离散事件状态，1：Assert；0：Deassert

bmc.kepler.Systems.DiskCoolingConfig

属性

属性名	类型	可读写	信号通知	描述
`DiskRowTemperatureAvailable`	`Boolean`	只读	变更广播	背板上硬盘温度是否能正常获取
`SysHDDsMaxTemperature`	`Double`	只读	变更广播	HDD硬盘最大温度, 单位:摄氏度
`SysSSDsMaxTemperature`	`Double`	只读	变更广播	SSD硬盘最大温度(仅SAS/SATA), 单位:摄氏度
`SysM2sMaxTemperature`	`Double`	只读	变更广播	M.2硬盘最大温度, 单位:摄氏度
`SysAllSSDsMaxTemperature`	`Double`	只读	变更广播	所有SDD介质硬盘的最大温度, 单位:摄氏度

bmc.kepler.Systems.EnergyEfficiencyOptimization

属性

属性名	类型	可读写	信号通知	描述
`Mode`	`String`	读写	变更广播	智能节能模式
`BusinessLoad`	`String`	读写	变更广播	业务负载

方法

`SetConfiguration`

描述： 保存节能配置

输入参数：

参数名	类型	描述
`BusinessLoad`	`String`	业务负载
`Configuration`	`String`	节能配置

bmc.kepler.Systems.EnergyMetric

属性

属性名	类型	可读写	信号通知	描述
`SystemPower`	`U32`	只读	变更广播	系统总输入功率(单位W)
`SystemOutputPower`	`U32`	只读	变更广播	系统总输出功率(单位W)
`HighPowerThresholdWatts`	`Double`	只读	变更广播	电源功率过高告警门限
`PowerConsumption`	`Double`	只读	变更广播	累计耗电量（单位Kw*h）
`MaxConsumedWatts`	`U32`	只读	变更广播	峰值功率（系统最大功率，单位W）
`MaxConsumedOccurredTime`	`U32`	只读	变更广播	峰值功率出现时间(时间戳)
`MinConsumedWatts`	`U32`	只读	变更广播	系统最小功率（单位W）
`StatisticsCollectedTime`	`U32`	只读	变更广播	开始统计时间(时间戳)
`AverageConsumedWatts`	`U32`	只读	变更广播	系统平均功率（单位W）
`HeatKcal`	`U32`	只读	变更广播	系统电源消耗热量（单位Kcal），由累计耗电量乘以860.42并舍去小数部分
`EnergySavedPercent`	`U8`	只读	变更广播	省电百分比
`EnergySavedKwh`	`Double`	只读	变更广播	省电总量KWh
`CarbonEmissionsReducedKg`	`Double`	只读	变更广播	减少碳排量(单位千克)
`FanTotalPowerWatts`	`U32`	只读	变更广播	风扇总功耗(单位瓦特)
`PredictedPowerSavedKwh`	`Double`	只读	变更广播	开启节能功能后预计节省功耗
`PredictedPowerSavedPercent`	`Double`	只读	变更广播	开启节能功能后预计节省功耗百分比
`TotalPowerSavedKwh`	`Double`	只读	变更广播	累计节省功耗
`TotalPowerSavedPercent`	`Double`	只读	变更广播	累计节省功耗百分比
`PowerPredictStatus`	`U8`	只读	变更广播	功耗预测模型状态
`PowerPredictDescription`	`String`	只读	变更广播	功耗预测工作状态描述
`HistoryPowerAverageWatts`	`U32`	只读	变更广播	节能特性开启前平均功率

方法

`PowerResetStatistics`

描述： 重置功耗统计数据

`CollectPowerHistoryData`

描述： 收集历史功率数据

输入参数：

参数名	类型	描述
`FilePath`	`String`	文件导出路径
`Domain`	`String`	数据域
`DomainId`	`U32`	域Id

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务Id

`ResetPowerHistoryData`

描述： 清空历史功率数据

输入参数：

参数名	类型	描述
`Domain`	`String`	数据域
`DomainId`	`U32`	域Id

`GetPowerHistoryData`

描述： 获取历史功耗统计数据

输入参数：

参数名	类型	描述
`Domain`	`String`	数据域
`DomainId`	`U32`	域Id

输出参数：

参数名	类型	描述
`PowerHistoryData`	`Array`	收集历史功耗数据

`SetHighPowerThresholdWatts`

描述： 设置功耗告警阈值

输入参数：

参数名	类型	描述
`HighPowerThresholdWatts`	`Double`	功耗告警阈值

`GetPredictedPowerData`

描述： 获取功耗预测数据

输出参数：

参数名	类型	描述
`PredictedPowerData`	`Array`	预测的未来整机功耗

`GetPredictedPowerSavedData`

描述： 获取节能收益预测数据

输出参数：

参数名	类型	描述
`PredictedPowerSavedData`	`Array`	开启节能功能后模型预测的未来整机功耗

自定义类型

PowerHistoryDataItem 结构：

字段名	类型	描述
Time	String	统计时间
PowerWatts	U32	系统功率
PowerAverageWatts	U32	系统平均功率
PowerPeakWatts	U32	系统峰值功率

PredictedPowerDataItem 结构：

字段名	类型	描述
Time	String	预测时间
PredictedPowerWatts	U32	预测时间的整机功耗

PredictedPowerSavedDataItem 结构：

字段名	类型	描述
Time	String	预测时间
PredictedPowerSavedWatts	U32	开启节能功能后模型预测的未来整机功耗

bmc.kepler.Systems.Entity

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	Entity Id，IPMI 规范 43.14
`Instance`	`U8`	只读	变更广播	Entity Instance，IPMI 规范 43.1中描述Instance配置，默认值 96
`Slot`	`U8`	只读	变更广播	Entity所在的槽位号，默认 255
`Name`	`String`	只读	变更广播	Entity的名称
`PowerState`	`U8`	只读	变更广播	Entity的上下电状态，关联对应的上下电信号来源
`Presence`	`U8`	只读	变更广播	Entity的在位状态，关联对应的在位信号来源
`Health`	`U8`	只读	变更广播	Entity的健康状态，不需要配置，默认值 0

bmc.kepler.Systems.EventSummary

属性

属性名	类型	可读写	信号通知	描述
`MinorCount`	`U32`	只读	变更广播	当前system的一般事件的汇总数量
`MajorCount`	`U32`	只读	变更广播	当前system的严重事件的汇总数量
`CriticalCount`	`U32`	只读	变更广播	当前system的紧急事件的汇总数量

bmc.kepler.Systems.Events

属性

属性名	类型	可读写	信号通知	描述
`Health`	`String`	只读	变更广播	系统健康状态,取值有0：Normal，1：Minor，2：Major，3：Critical
`EventRecordSeq`	`U64`	只读	变更广播	事件记录标识，随着事件产生递增
`CriticalCount`	`U32`	只读	变更广播	致命告警数量
`MajorCount`	`U32`	只读	变更广播	严重告警数量
`MinorCount`	`U32`	只读	变更广播	一般告警数量
`Version`	`String`	只读	变更广播	当前事件配置的版本
`CurEventCount`	`U32`	只读	变更广播	当前事件数量
`MaxEventCount`	`U32`	只读	变更广播	最大事件数量
`DumpRecord`	`U64`	只读	变更广播	SEL日志转储的总量，每次转储均会累加
`MajorVersion`	`String`	只读	变更广播	告警语言配置的主版本
`MinorVersion`	`String`	只读	变更广播	告警语言配置的次要版本
`AuxVersion`	`String`	只读	变更广播	告警语言配置的辅助版本
`EventMode`	`U8`	读写	变更广播	事件的记录模式，0: 默认模式，记录达到最大数量后转储； 1：记录达到最大数量后环形记录

方法

`MockEvent`

描述： 事件模拟接口

输入参数：

参数名	类型	描述
`EventCode`	`String`	事件码
`Enabled`	`U8`	模拟状态标识，1：开启模拟，0：关闭模拟
`ObjectIndex`	`U16`	事件下标
`MockState`	`U8`	事件状态，1：生成告警，0：恢复告警

`GetAlarmList`

描述： 查询当前告警接口

输入参数：

参数名	类型	描述
`StartId`	`U16`	事件索引
`Count`	`U16`	事件条数
`QueryParameters`	`Array`	带查询参数列表

输出参数：

参数名	类型	描述
`Total`	`U16`	事件总条数
`EventList`	`Array`	事件详细信息列表

`GetEventList`

描述： 查询历史事件接口

输入参数：

参数名	类型	描述
`StartId`	`U16`	事件索引
`Count`	`U16`	事件条数
`QueryParameters`	`Array`	可选参数包括:1.语言(en:英文 zh:中文默认英文)2.SelLevel日志级别(Informational/Minor/Major/Critical)3.SelObjectType主体类型4.SelBeginTime开始事件戳(yyyy-MM-dd HH:mm:ss)5.SelEndTime结束时间戳6.SelSearchString关键字,用于模糊匹配事件描述、事件码,ASCII范围(0x20~0x7E),长度0~20字符

输出参数：

参数名	类型	描述
`Total`	`U16`	事件总条数
`EventList`	`Array`	事件详细信息列表

`ClearEventList`

描述： 清除全部事件

`GetEventInfo`

描述： 查询系统信息

输出参数：

参数名	类型	描述
`Version`	`String`	事件配置版本
`CurEventCount`	`U16`	当前事件数量
`MaxEventCount`	`U16`	最大事件数量

`MaskEvent`

描述： 屏蔽事件接口

输入参数：

参数名	类型	描述
`EventCode`	`String`	事件码
`MaskState`	`U8`	屏蔽状态, 0:开启屏蔽 1:关闭屏蔽
`Mode`	`U8`	屏蔽模式, 1:NONE,不保存屏蔽状态,重启失效 2:RESET,重启后保持屏蔽 3:AC后保持屏蔽

`GetMaskedEventList`

描述： 查询屏蔽事件列表

输出参数：

参数名	类型	描述
`MaskedEventList`	`Array`	屏蔽事件列表信息

`AddEvent`

描述： 添加软件事件接口

输入参数：

参数名	类型	描述
`EventInfo`	`Array`	必选参数:(ComponentName:事件主体名称 State:事件状态 EventKeyId:事件标识 EventName:事件名称 MessageArgs:动态参数列表 SystemId:事件归属的SystemId ManagerId:事件归属的ManagerId ChassisId:事件归属的ChassisId NodeId:事件对应的对象) 可选参数:(SubjectType:事件主体类型)

输出参数：

参数名	类型	描述
`RecordId`	`String`	添加事件的记录标识

`ExportEvent`

描述： 导出历史事件记录

输入参数：

参数名	类型	描述
`Path`	`String`	导出历史事件的路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	Task标识, 用于拼接任务路径

`CheckEventName`

描述： 校验Eventname集合

输入参数：

参数名	类型	描述
`EventName`	`String[]`	需要校验的EventName列表

输出参数：

参数名	类型	描述
`Result`	`Boolean[]`	校验的结果列表

`SetAlarmName`

描述： 定制告警名称

输入参数：

参数名	类型	描述
`AlarmName`	`String`	定制的告警名称

`SetEventSeverity`

描述： 设置事件的严重等级

输入参数：

参数名	类型	描述
`EventCode`	`String`	告警码
`Severity`	`U8`	设置的告警级别(0:Normal 1:Minor 2:Major 3:Critical)

`SetEventAction`

描述： 设置事件产生后的动作

输入参数：

参数名	类型	描述
`EventKeyId`	`String`	告警定义
`Action`	`U8`	设置的事件动作(0:无动作 1:下电0S 2:复位OS 3:下电后上电)

`AddSel`

描述： 动态添加oem的sel生成对应的event

输入参数：

参数名	类型	描述
`EventInfo`	`Array`	必选参数:(EventCode:事件码 State:事件状态 Severity:事件严重等级 Description:事件描述 OldEventCode:旧事件码)等

自定义类型

EventInfo 结构：

字段名	类型	描述
MappingTable	Array	事件信息键值表,键的值包括:严重程度，事件关联的组件名称，事件状态，事件码，事件产生时间戳，事件描述，事件建议，事件原因，事件影响，事件动作，事件策略标识，事件上报通道掩码，事件触发模式，led显示故障码，旧事件码，事件主体类型，事件名称，事件动态参数，事件归属的SystemId，事件归属的ManagerId，事件归属的ChassisId，事件对应的对象

KeyValueTable 结构：

字段名	类型	描述
Key	String
Value	String

MaskedEventInfo 结构：

字段名	类型	描述
EventCode	String	被屏蔽事件的事件码
EventName	String	被屏蔽事件的事件标识

bmc.kepler.Systems.ExceptionInfo

属性

属性名	类型	可读写	信号通知	描述
`CaterrDiagnoseResult`	`U8`	只读	变更广播	根据CATERR诊断结果触发对应事件
`LocalSystemId`	`U8`	只读	变更广播	故障所在系统的物理编号,主系统编号0,同一个主系统内的子系统依次编号,从1开始

方法

`DumpProcessorLog`

描述： 宕机收集

输入参数：

参数名	类型	描述
`LogType`	`String`	宕机收集支持的类型,当前只支持'RAS', 预留扩展'ALL'、'RAS'
`Path`	`String`	宕机收集的文件路径,指定目录'/tmp'或缺省，缺省情况下目录是'/tmp'

输出参数：

参数名	类型	描述
`TaskId`	`U32`	Dump Processor Log Task Id

bmc.kepler.Systems.FDMDomain.CPURAS

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	CPU所在的系统的Id
`LogicalId`	`U8`	只读	变更广播	CPU逻辑Id
`BISTFailed`	`U8`	只读	变更广播	内建自检失败
`CorrectableError`	`U8`	只读	变更广播	CPU关键模块发生的可纠正错误, 取值: 0-未发生,1-发生
`UncorrectableError`	`U8`	只读	变更广播	CPU关键模块发生的不可纠正错误, 取值: 0-未发生,1-发生
`Isolated`	`U8`	只读	变更广播	故障CPU被隔离
`CoreIsolated`	`U8`	只读	变更广播	CPU核隔离
`IsolatedCoreId`	`String`	只读	变更广播	CPU核隔离的核id
`ConfigErrorType`	`U8`	只读	变更广播	配置错误类型
`ConfigErrorCode`	`String`	只读	变更广播	配置错误具体错误码(十六进制字符串格式)
`ModelMismatched`	`U8`	只读	变更广播	CPU型号不匹配
`FirmwareMismatched`	`U8`	只读	变更广播	固件不匹配
`InterConnectionLaneFault`	`U8`	只读	变更广播	CPU互联链路异常
`InterConnectionLaneErrorMask`	`U8`	只读	变更广播	CPU互联总线(HCCS)故障Lane编号/位图,举例:bit0:Lane0;bit1:Lane1
`CacheWayErrorMask`	`U8`	只读	变更广播	CacheWay异常状态，0表示正常，bit位：0表示L1，1表示L2，2表示L3

bmc.kepler.Systems.FDMDomain.MemoryOnChipRAS

属性

属性名	类型	可读写	信号通知	描述
`CorrectableECC`	`U8`	只读	变更广播	MemoryOnChip发生可纠正错误, 取值: 0-未发生,1-发生
`UncorrectableECC`	`U8`	只读	变更广播	MemoryOnChip发生不可纠正错误发生, 取值：0-未发生，1-发生
`ScrubingUncorrectableECC`	`U8`	只读	变更广播	MemoryOnChip发生巡检UCE错误, 取值：0-未发生，1-发生
`ParityError`	`U8`	只读	变更广播	MemoryOnChip发生奇偶校验错误, 取值：0-未发生，1-发生
`CorrectableECCStorm`	`U8`	只读	变更广播	MemoryOnChip发生CE风暴错误, 取值：0-未发生，1-发生
`CorrectableECCOverflow`	`U8`	只读	变更广播	MemoryOnChip发生CE漏斗溢出错误, 取值：0-未发生，1-发生

bmc.kepler.Systems.FDMDomain.MemoryRAS

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	内存所在系统的id
`Name`	`String`	只读	变更广播	内存对象名称
`LogicalCpuId`	`U8`	只读	变更广播	内存所属的CPU id
`LogicalChannelId`	`U8`	只读	变更广播	内存所属逻辑通道id
`DimmId`	`U8`	只读	变更广播	内存对应Dimm条id
`PredictiveFault`	`U8`	只读	变更广播	硬件预故障
`ConfigErrorType`	`U8`	只读	变更广播	配置错误类型
`ConfigErrorCode`	`String`	只读	变更广播	配置错误具体错误码(十六进制字符串格式)
`ScrubingUncorrectableECC`	`U8`	只读	变更广播	内存发生巡检UCE错误, 取值：0-未发生，1-发生
`ParityError`	`U8`	只读	变更广播	内存发生奇偶校验错误, 取值：0-未发生，1-发生
`UncorrectableECCError`	`U8`	只读	变更广播	不可纠正错误发生
`CorrectableECCError`	`U8`	只读	变更广播	多次发生可纠正错误导致CE统计超门限
`CorrectableECC`	`U8`	只读	变更广播	内存发生可纠正错误, 取值: 0-未发生,1-发生
`PoorContactFault`	`U8`	只读	变更广播	内存接触类故障，0:无故障；1:有故障
`LastPredictTime`	`U32`	只读	变更广播	上一次内存产生故障时间
`HealthScore`	`U8`	只读	变更广播	健康分数
`LastIsolationStatus`	`U8`	只读	变更广播	上一次内存隔离状态
`ErrorStormCount`	`U32`	只读	变更广播	内存条的CE风暴次数
`CorrectableECCStorm`	`U8`	只读	变更广播	内存发生CE风暴, 取值: 0-未发生,1-非定制规则下发生CE风暴,其他-定制规则下发生CE风暴
`CorrectableECCOverflow`	`U8`	只读	变更广播	内存发生CE漏斗溢出, 取值: 0-未发生,其他-发生

bmc.kepler.Systems.FDMDomain.NPURAS

属性

属性名	类型	可读写	信号通知	描述
`CarrierBoardId`	`U8`	只读	变更广播	NPU载板Id
`NPUIndex`	`U8`	只读	变更广播	实体NPU编号
`DieIndex`	`U8`	只读	变更广播	NPU内die编号
`PredictiveFault`	`U8`	只读	变更广播	硬件预故障标志位，默认值0，异常状况置1
`DiagnosticFault`	`U8`	只读	变更广播	FDM诊断发现故障的标志位，默认值0，异常状况置1
`InterConnectionLaneErrorBitmap`	`U32`	只读	变更广播	NPU互联总线(HCCS)故障macro编号/位图, bit0对应macro0, 以此类推。其中0表示正常, 1表示异常

bmc.kepler.Systems.FDMDomain.PCIeRASCollector

属性

属性名	类型	可读写	信号通知	描述
`CorrectableError`	`U8`	只读	变更广播	PCIe设备发生可纠正错误, 取值: 0-未发生, 1-发生
`UncorrectableError`	`U8`	只读	变更广播	PCIe设备发生不可纠正错误, 取值: 0-未发生,1-发生
`FatalError`	`U8`	只读	变更广播	PCIe设备发生致命错误, 取值: 0-未发生,1-发生
`ParityError`	`U8`	只读	变更广播	PCIe设备发生奇偶校验错误, 取值: 0-未发生,1-发生
`SystemError`	`U8`	只读	变更广播	PCIe设备发生系统错误, 取值: 0-未发生,1-发生
`BandwidthReduction`	`U8`	只读	变更广播	PCIe降带宽检事件的上报属性
`LinkSpeedReduced`	`U8`	只读	变更广播	PCIe设备降速率检测告警上报事件属性
`DevSegment`	`U8`	只读	变更广播	事件对应PCIe设备的Segment
`DevBus`	`U8`	只读	变更广播	事件对应PCIe设备的Bus
`DevDevice`	`U8`	只读	变更广播	事件对应PCIe设备的Device
`DevFunction`	`U8`	只读	变更广播	事件对应PCIe设备的Function

bmc.kepler.Systems.FDMDomain.SystemRAS

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统Id
`NoMemoryDetectedInPOST`	`U8`	只读	变更广播	POST阶段检测不到内存
`MemoryConfigErrorType`	`U8`	只读	变更广播	系统内存配置错误类型
`MemoryConfigErrorCode`	`String`	只读	变更广播	系统内存配置错误具体错误码(十六进制字符串格式)

bmc.kepler.Systems.FDMService

属性

属性名	类型	可读写	信号通知	描述
`UnknownCaterrPolicy`	`String`	读写	变更广播	FDM CATERR诊断失败处理策略。NoAction：不做任何处理；Reset：热复位；PowerOff：下电
`IdentifiedCaterrPolicy`	`String`	读写	变更广播	FDM CATERR诊断成功处理策略。NoAction：不做任何处理；Reset：热复位
`MemFaultIsolationMode`	`String`	读写	变更广播	设置内存故障隔离总开关状态
`MemPoorContactAlarmEnabled`	`Boolean`	读写	变更广播	内存DQ线接触不良(poor contact)告警功能开关
`MemFaultIsolationEnabled`	`Boolean`	只读	变更广播	内存故障隔离总开关，仅有总开关开启时,其他隔离功能才能生效
`MemPageOfflineEnabled`	`Boolean`	读写	变更广播	内存页隔离(PageOffline)容错功能开关
`MemADDDCEnabled`	`Boolean`	读写	变更广播	内存自适应双设备数据校正(Adaptive Double DRAM Device Correction, ADDDC)容错功能开关
`MemSoftPPREnabled`	`Boolean`	读写	变更广播	内存软后包修复(soft post package repair, sPPR)容错功能开关
`MemHardPPREnabled`	`Boolean`	读写	变更广播	内存硬后包修复(hard post package repair, hPPR)容错功能开关
`MemACLSEnabled`	`Boolean`	读写	变更广播	内存单比特纠错算法(ACLS)容错功能开关
`MaxMemPageOfflineCount`	`U32`	读写	变更广播	PageOffline容错能力上限值
`MemHardFailureDetectionMode`	`String`	读写	变更广播	内存硬失效模式判断方式。PatrolScrub：巡检识别硬失效模式；ExpertRule：规则识别硬失效模式
`MemFaultPredictionEnabled`	`Boolean`	读写	变更广播	内存故障预测开关状态
`MemFaultPredictionMode`	`String`	读写	变更广播	内存故障预测模式, ExpertRule(专家规则模式)
`HbmFPCEnabled`	`Boolean`	读写	变更广播	CPU HBM FPC总开关
`HbmACLSEnabled`	`Boolean`	读写	变更广播	CPU HBM ACLS开关
`HbmSoftPPREnabled`	`Boolean`	读写	变更广播	CPU HBM SPPR开关

方法

`SetMemFaultIsolationEnabled`

描述： 设置内存故障隔离总开关状态

输入参数：

参数名	类型	描述
`Status`	`Boolean`	内存故障隔离总开关状态

`GetFPCMemoryRecords`

描述： 返回所有内存条基础信息、隔离状态与健康分值

输出参数：

参数名	类型	描述
`FPCMemoryRecords`	`Array`	内存条信息，包括内存条基础信息、隔离状态与健康分值

`GetPendingMemIsolation`

描述： 获取联动模式下一次上电期间所有内存待隔离的颗粒信息

输出参数：

参数名	类型	描述
`PendingList`	`Array`	一次上电期间所有内存待隔离的颗粒信息

`ExecuteMemIsolation`

描述： 联动模式下执行对应id的隔离任务

输入参数：

参数名	类型	描述
`SequenceNumList`	`U32[]`	待执行内存隔离记录集合

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务标识

自定义类型

FPCMemoryItem 结构：

字段名	类型	描述
SystemId	String
TimeStamp	U32
TimeZone	S32
Socket	U8
Channel	U8
Slot	U8
DeviceLocator	String
SerialNumber	String
HealthScore	U8
IsolationStatus	U8

IsolationItem 结构：

字段名	类型	描述
SystemId	String
SequenceNum	U32
TimeStamp	U64
ExecutionStatus	U8
FailureMode	String
AddressInfo	String

bmc.kepler.Systems.Fan

属性

属性名	类型	可读写	信号通知	描述
`FanId`	`U16`	只读	变更广播	风扇ID
`Slot`	`U8`	只读	变更广播	风扇槽位
`Type`	`U8`	只读	变更广播	风扇类型
`Model`	`String`	只读	变更广播	风扇型号
`Coefficient`	`U8`	只读	变更广播	风扇转速系数
`FanHealth`	`U8`	只读	变更广播	风扇健康状态
`FanEntity`	`String`	只读	变更广播	风扇实体
`FrontPresence`	`U8`	读写	变更广播	前转子在位状态
`RearPresence`	`U8`	读写	变更广播	后转子在位状态
`FrontSpeed`	`U16`	读写	变更广播	前转子转速
`RearSpeed`	`U16`	读写	变更广播	后转子转速
`FrontStatus`	`U8`	只读	变更广播	前转子状态
`RearStatus`	`U8`	只读	变更广播	后转子状态
`FrontRPM`	`U16`	只读	变更广播	前转子转速
`RearRPM`	`U16`	只读	变更广播	后转子转速
`HardwarePWM`	`Double`	读写	变更广播	硬件占空比
`PWMPercentage`	`U32`	只读	变更广播	占空比
`ExpectedPWM`	`Double`	读写	变更广播	预期占空比
`FanAlarmLed`	`U8`	只读	变更广播	风扇告警
`BOM`	`String`	只读	变更广播	BOM编码
`SystemId`	`U8`	只读	变更广播	系统Id
`MaxSupportedPWM`	`U32`	只读	变更广播	支持的最大转速
`IdentifySpeedLevel`	`U8`	只读	变更广播	识别风速级别
`PartNumber`	`String`	只读	变更广播	部件编码
`FrontMaxSpeed`	`U32`	只读	变更广播	前转子最大转速
`RearMaxSpeed`	`U32`	只读	变更广播	后转子最大转速
`IsTwins`	`Boolean`	只读	变更广播	是否为双转子
`Position`	`String`	只读	变更广播	容器信息
`SpeedStable`	`Boolean`	只读	变更广播	风扇转速是否稳定（true:稳定，false:不稳定）,期望转速与实际转速比相差25%以内为稳定
`FunctionDesc`	`String`	只读	变更广播	功能描述
`DeviceName`	`String`	只读	变更广播	部件名称

方法

`SetFanPWM`

描述： 设置风扇转速

输入参数：

参数名	类型	描述
`PWM`	`Double`	风扇转速占空比

输出参数：

参数名	类型	描述
`Result`	`U8`	返回结果，0：设置成功；1：设置失败

bmc.kepler.Systems.FanSnapshot

方法

`GetActivatedPolicyFactors`

描述： 获取已激活的风扇转速最高的调速策略因子

输出参数：

参数名	类型	描述
`RetData`	`Struct`	返回的数据，数据内容包括：ValidFlag、ActivatedType、PWM和FactorName

自定义类型

FanSnapshot 结构：

字段名	类型	描述
ValidFlag	Boolean	表示Cooling组件是否有获取到风扇信息，true表示获取成功，false表示获取失败
ActivatedType	U8	策略激活类型，1表示触发异常调速，0表示无异常调速
PWM	U8	风扇转速百分比
FactorName	String	当前转速生效的调速因子名称

bmc.kepler.Systems.FanType

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	风扇型号名
`Index`	`U8`	只读	变更广播	风扇型号索引
`IsDefaultType`	`Boolean`	只读	变更广播	是否为默认风扇型号
`IsTwins`	`Boolean`	只读	变更广播	是否为双转子
`FrontMaxSpeed`	`U32`	只读	变更广播	前转子最大转速
`RearMaxSpeed`	`U32`	只读	变更广播	后转子最大转速
`IdentifyRangeLow`	`U32`	只读	变更广播	风扇型号识别转速左区间
`IdentifyRangeHigh`	`U32`	只读	变更广播	风扇型号识别转速右区间
`MatchedCount`	`U8`	只读	变更广播	识别风扇数量
`PartNumber`	`String`	只读	变更广播	部件编码
`BOM`	`String`	只读	变更广播	BOM编码
`SystemId`	`U8`	只读	变更广播	系统Id
`SpeedRange`	`U8[]`	只读	变更广播	风扇转速和功率映射关系的风扇转速数组
`PowerRange`	`U16[]`	只读	变更广播	风扇转速和功率映射关系的功率数组
`FanDiameterMm`	`U16`	只读	变更广播	风扇组件的直径，单位毫米

bmc.kepler.Systems.Fans

属性

属性名	类型	可读写	信号通知	描述
`WorkInStandby`	`U8`	只读	变更广播	standby下风扇是否可以运转
`EstimatedTotalPowerWatts`	`U16`	只读	变更广播	估算的整机风扇总功耗

方法

`SetPWM`

描述： 设置所有风扇转速

输入参数：

参数名	类型	描述
`PWM`	`Double[]`	风扇转速占空比数组

输出参数：

参数名	类型	描述
`Result`	`U8`	返回结果，0：设置成功；1：设置失败

bmc.kepler.Systems.Fru

属性

属性名	类型	可读写	信号通知	描述
`PcbId`	`U8`	只读	变更广播	PcbId, 需要关联到硬件, 从硬件读取Id
`PcbVersion`	`String`	只读	变更广播	PCB版本, 根据PcbId的值进行计算得出
`FruId`	`U8`	只读	变更广播	FruId
`FruName`	`String`	只读	变更广播	Fru名称
`PowerState`	`U8`	只读	变更广播	Fru的热插拔状态
`Health`	`U8`	只读	变更广播	健康状态
`EepStatus`	`U8`	只读	变更广播	EEPROM状态
`GroupPosition`	`String`	只读	变更广播	FRU的位置信息, 来自自发现的Position属性, 该属性用于确定FruId
`Type`	`U8`	只读	变更广播	FRU类型,TYPE值请参照IPD Lite的BMC IPMI接口说明附录
`FruDataId`	`String`	只读	变更广播	关联frudata对象名
`BoardId`	`U16`	只读	变更广播	非天池:组件单板BoardID
`UniqueId`	`String`	只读	变更广播	天池:组件唯一标识,Vendor + ComponentID
`ConnectorGroupId`	`U32`	只读	变更广播	关联Connector传过来的GroupId

bmc.kepler.Systems.FruCtrl

属性

属性名	类型	可读写	信号通知	描述
`PowerState`	`String`	只读	变更广播	反映实时电源状态
`SysResetDetected`	`U8`	只读	变更广播	系统复位信号
`FruType`	`String`	只读	变更广播	上下电的Fru类型信息：host、NP加速卡、交换mesh卡
`CurrentRestartCause`	`String`	只读	变更广播	用于记录业务系统本次复位原因
`CurrentRestartCauseId`	`U8`	只读	变更广播	与CurrentRestartCause对应id
`CurrentRestartType`	`U8`	只读	变更广播	当前系统复位类型，取值0:Initiated by power up,1:Initiated by hard reset, 2:Initiated by warm reset
`RestartCauseRecords`	`String[]`	只读	变更广播	用于记录业务系统历史复位原因，最多纪录10次
`RestartCount`	`U8`	只读	变更广播	用于纪记录业务系统复位次数
`PowerOnStrategy`	`String`	读写	变更广播	通电开机策略
`PowerOnStrategyExceptions`	`U32`	读写	变更广播	殊通电开机策略，1为不执行此次通电开机策略，0为清除策略
`PanelPowerButtonEnabled`	`Boolean`	读写	变更广播	面板按钮使能true，不屏蔽为false
`GracefulShutdownTimeoutEnabled`	`U32`	读写	变更广播	安全下电时限使能开关
`GracefulShutdownTimeoutSeconds`	`U32`	读写	变更广播	安全下电超时时间，超时后执行强制下电
`GracefulShutdownDefaultTimeoutSeconds`	`U32`	只读	变更广播	安全下电默认超时时间，关联CSR
`GracefulShutdownMaxTimeoutSeconds`	`U32`	只读	变更广播	安全下电超时时间上限，关联CSR
`GracefulShutdownMinTimeoutSeconds`	`U32`	只读	变更广播	安全下电超时时间上限，关联CSR
`HotswapState`	`String`	只读	变更广播	上下电流程中内部状态机流转产生，需要通知到事件
`LastPowerEvent`	`U8`	只读	变更广播	仅对上电做事件记录复位持久化
`PowerCtrlFault`	`U8`	只读	变更广播	判断上一次上电是否上电成功，或下电命令是否下电成功复位持久化
`PowerCycleType`	`U8`	只读	变更广播	0: 无power cycle任务;1: 有power cycle任务;2: 有force power cycle任务
`PreviousPowerState`	`String`	只读	变更广播	表示上次通电状态 On: 上电状态;Off: 下电状态

方法

`PowerCtrl`

描述： 上下电操作

输入参数：

参数名	类型	描述
`PowerCtrlType`	`String`	操作类型
`RestartCause`	`String`	重启原因

输出参数：

参数名	类型	描述
`CmdResult`	`S32`	命令执行结果

`SetPowerOnStrategyExceptions`

描述： 配置例外通电开机策略

输入参数：

参数名	类型	描述
`Reason`	`String`	调用原因描述
`Execute`	`String`	例外通电开机策略 Yes: 下次重启执行通电开机 No: 下次重启不执行通电开机策略 None:下次重启清除额外的通电开机策略
`EffectivePeriod`	`String`	生效周期 Once:单次 Continuous:永久
`Priority`	`U8`	生效优先级 1-10 1:redfish(外部) 2:内部调用

输出参数：

参数名	类型	描述
`CmdResult`	`U32`	命令执行结果

`SetACLost`

描述： 通知fructrl组件发生整框掉电

输入参数：

参数名	类型	描述
`Type`	`U8`	整框掉电类型, 1:powerdrop引起的AClost

输出参数：

参数名	类型	描述
`CmdResult`	`U32`	命令执行结果

`FruPowerCtrl`

描述： 根据FruID进行上下电操作

输入参数：

参数名	类型	描述
`PowerCtrlType`	`String`	操作类型 On:上电 ForceOff:强制下电 GracefulShutDown:安全下电 ForceRestart:强制重启 ForcePowerCycle:强制下电再上电 PowerCycle:安全下电再上电 ACCycle:整框掉电
`RestartCause`	`String`	重启原因, 详见fructrl组件readme
`FruID`	`U8`	FruID类型 0:计算域 4:交换域

输出参数：

参数名	类型	描述
`CmdResult`	`S32`	命令执行结果 0:表示执行成功 -1:表示执行失败

bmc.kepler.Systems.FruData.Board

属性

属性名	类型	可读写	信号通知	描述
`MfgDate`	`String`	只读	变更广播	生产日期
`BoardManufacturer`	`String`	只读	变更广播	单板生产厂商默认Huawei
`BoardProductName`	`String`	只读	变更广播	单板产品名称
`BoardSerialNumber`	`String`	只读	变更广播	单板系列化编号
`BoardPartNumber`	`String`	只读	变更广播	单板部件号
`BoardFRUFileID`	`String`	只读	变更广播	单板FRufileID
`BoardCustomInfo`	`String`	只读	变更广播	单板自定义信息

bmc.kepler.Systems.FruData.Chassis

属性

属性名	类型	可读写	信号通知	描述
`ChassisType`	`String`	只读	变更广播	关联的Chassis类型
`ChassisPartNumber`	`String`	只读	变更广播	关联的Chassis部件号
`ChassisSerialNumber`	`String`	只读	变更广播	关联的Chassis序列号
`ChassisCustomInfo`	`String`	只读	变更广播	关联的Chassis扩展域

bmc.kepler.Systems.FruData.Overview

属性

属性名	类型	可读写	信号通知	描述
`FruId`	`U8`	只读	变更广播	关联所在的Fru的Fruid
`FruType`	`String`	只读	变更广播	关联所在的Fru的类型
`FruName`	`String`	只读	变更广播	关联所在的Fru的名字

bmc.kepler.Systems.FruData.Product

属性

属性名	类型	可读写	信号通知	描述
`ManufacturerName`	`String`	只读	变更广播	制造商名称
`ProductName`	`String`	只读	变更广播	产品名，由整机测写入
`ProductPartNumber`	`String`	只读	变更广播	产品部件号
`ProductVersion`	`String`	只读	变更广播	产品网元类型/版本号，由产品软件定义
`ProductSerialNumber`	`String`	只读	变更广播	产品序列号
`AssetTag`	`String`	只读	变更广播	客户资产号，由客户定义
`ProductFRUFileID`	`String`	只读	变更广播	产品fru编号
`ProductCustomInfo`	`String`	只读	变更广播	产品定制信息

bmc.kepler.Systems.FruData.System

属性

属性名	类型	可读写	信号通知	描述
`SystemManufacturer`	`String`	只读	变更广播	系统制造商
`SystemProductName`	`String`	只读	变更广播	系统产品名称
`SystemVersion`	`String`	只读	变更广播	系统版本
`SystemSerialNumber`	`String`	只读	变更广播	系统序列号

bmc.kepler.Systems.Frus

bmc.kepler.Systems.HBM

属性

属性名	类型	可读写	信号通知	描述
`LogicTemperatureCelsius`	`Double`	只读	变更广播	HBM Logic区域温度
`DRAMTemperatureCelsius`	`Double`	只读	变更广播	HBM DRAM区域温度

bmc.kepler.Systems.HddBackplane

属性

属性名	类型	可读写	信号通知	描述
`StartSlot`	`U8`	只读	变更广播	指定硬盘起始槽位号

bmc.kepler.Systems.HistoryTemperature

属性

属性名	类型	可读写	信号通知	描述
`TemperatureType`	`U32`	只读	变更广播	温度类型, 11:进风口

方法

`GetData`

描述： 获取温度点历史温度数据

输出参数：

参数名	类型	描述
`RetData`	`Array`	返回的温度点历史温度数据

`ClearData`

描述： 清空温度点历史温度数据

自定义类型

TemperatureDataItem 结构：

字段名	类型	描述
Time	String	统计时间
InletTempCelsius	S32	温度值

bmc.kepler.Systems.IPMIEvent

属性

属性名	类型	可读写	信号通知	描述
`SensorType`	`U8`	只读	变更广播	IPMI 事件的传感器类型
`ReadingType`	`U8`	只读	变更广播	IPMI 事件的事件读值类型，复位持久化，事件类型来自于HOST侧上报
`EventData`	`U32`	只读	变更广播	IPMI 事件的SEL数据，复位持久化，事件数据来自于HOST侧上报或者HOST上下电状态变化感知

bmc.kepler.Systems.IPv4Address

属性

属性名	类型	可读写	信号通知	描述
`Address`	`String`	只读	变更广播	IP地址
`SubnetMask`	`String`	只读	变更广播	子网掩码
`Gateway`	`String`	只读	变更广播	网关
`AddressOrigin`	`String`	只读	变更广播	地址模式

bmc.kepler.Systems.IPv6Address

属性

属性名	类型	可读写	信号通知	描述
`Address`	`String`	只读	变更广播	IP地址
`PrefixLength`	`String`	只读	变更广播	前缀长度
`AddressState`	`String`	只读	变更广播	地址状态
`AddressOrigin`	`String`	只读	变更广播	地址来源
`Gateway`	`String[]`	只读	变更广播	网关

bmc.kepler.Systems.Led

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	Led灯的名称
`OnDuration`	`U8`	只读	变更广播	亮灯持续时间默认值0
`OffDuration`	`U8`	只读	变更广播	关灯持续时间默认值0
`Capability`	`U8`	只读	变更广播	颜色，3:绿色，2:红色
`SystemId`	`U8`	只读	变更广播	系统id
`State`	`U8`	读写	变更广播	当前Led灯的状态
`Id`	`U8`	只读	变更广播	每个LED灯都会对应一个固定id
`FruId`	`U8`	只读	变更广播	关联的FRU id
`ColorCapabilities`	`U8`	只读	变更广播	Led灯支持的颜色能力
`LocalControlStateColor`	`String`	只读	变更广播	本地控制模式下的颜色
`OverrideStateColor`	`String`	只读	变更广播	超驰状态下的颜色
`Mode`	`U8`	只读	变更广播	Led模式

方法

`SetState`

描述： 设置Led灯的状态

输入参数：

参数名	类型	描述
`State`	`U8`	Led灯的状态
`Interval`	`U8`	闪烁状态持续时长

输出参数：

参数名	类型	描述
`State`	`U8`	Led灯的状态
`OnDuration`	`U8`	闪烁状态下亮灯持续时长
`OffDuration`	`U8`	闪烁状态下关灯持续时长

bmc.kepler.Systems.Led.Policy

属性

属性名	类型	可读写	信号通知	描述
`Normal`	`U16[]`	读写	变更广播	Normal等级亮灯策略
`Minor`	`U16[]`	读写	变更广播	Minor等级亮灯策略
`Major`	`U16[]`	读写	变更广播	Major等级亮灯策略
`Critical`	`U16[]`	读写	变更广播	Critical等级亮灯策略

bmc.kepler.Systems.LiquidCoolingConfig

属性

属性名	类型	可读写	信号通知	描述
`CtrlMode`	`String`	只读	变更广播	冷却单元的控制模式（自动/手动/混合）
`TimeOut`	`U32`	只读	变更广播	手动模式下的超时时间
`ManualLevel`	`U8`	只读	变更广播	手动模式下的转速级别
`LevelPercentRange`	`U8[]`	只读	变更广播	手动设置转速级别允许范围

方法

`SetManualLevel`

描述： 设置手动模式冷却级别

输入参数：

参数名	类型	描述
`UnitId`	`U8`	冷却单元Id
`Level`	`U8`	设置的转速级别

`SetCtrlMode`

描述： 设置冷却单元控制模式

输入参数：

参数名	类型	描述
`CtrlMode`	`String`	冷却单元控制模式
`Timeout`	`U32`	超时时长

bmc.kepler.Systems.MPCConfig

属性

属性名	类型	可读写	信号通知	描述
`Enabled`	`Boolean`	读写	变更广播	MPC是否使能，默认为false
`TotalPowerSavedKwh`	`Double`	只读	变更广播	MPC累计节省能耗,千瓦时
`LastStartTime`	`U32`	只读	变更广播	最近一次MPC开启时间
`Status`	`String`	只读	变更广播	MPC模型状态，当前存在5种取值类型，Idle空闲状态，Training训练状态，Active生效状态，Inactive不生效状态，Unavailable不可用状态

bmc.kepler.Systems.Mctp

属性

属性名	类型	可读写	信号通知	描述
`DiscoverFlag`	`U8`	只读	变更广播	发现的标志
`OwnerEid`	`U8`	只读	变更广播	ME的Eid
`OwnerPhy`	`U16`	只读	变更广播	ME的物理地址
`BmcEid`	`U8`	只读	变更广播	BMC的Eid
`BmcPhy`	`U16`	只读	变更广播	BMC的物理地址
`SystemId`	`U8`	只读	变更广播	系统Id
`TableStatus`	`U8`	只读	变更广播	路由表状态

bmc.kepler.Systems.Mctp.MctpBinding.PCIe

属性

属性名	类型	可读写	信号通知	描述
`OwnerEid`	`U8`	只读	变更广播	ME的Eid
`OwnerPhyAddr`	`U16`	只读	变更广播	ME的PCIe物理地址
`BmcEid`	`U8`	只读	变更广播	BMC的Eid
`BmcPhyAddr`	`U16`	只读	变更广播	BMC的PCIe物理地址
`DiscoverFinished`	`Boolean`	只读	变更广播	MCTP是否完成初始化
`RoutingTableReady`	`Boolean`	只读	变更广播	路由表是否就绪

bmc.kepler.Systems.Mctp.MctpBinding.SMBus

属性

属性名	类型	可读写	信号通知	描述
`BmcEid`	`U8`	只读	变更广播	SMBus协议使用的BMC的Eid
`BmcPhyAddr`	`U8`	只读	变更广播	SMBus协议使用的BMC的物理地址

bmc.kepler.Systems.Mctp.PCIeEndpoint

属性

属性名	类型	可读写	信号通知	描述
`ServiceName`	`String`	只读	变更广播	注册通道的模块名
`TargetEid`	`U8`	只读	变更广播	对端的Eid
`TargetPhyAddr`	`U16`	只读	变更广播	对端PhyAddr
`MessageType`	`U8`	只读	变更广播	协议类型
`MediumType`	`U8`	只读	变更广播	物理介质类型, 0x02:SMBus 2.0 or I2C 100 kHz compatible, 0x0f:PCI compatible (PCI 1.0, 2.0, 2.1, 2.2, 2.3, 3.0, PCI-X 1.0, PCI-X 2.0), 0x80:SMBus 2.0 + I2C 100 kHz OEM master binding
`Status`	`U8`	只读	变更广播	Endpoint状态, 0:初始状态, 1:Endpoint对象发现完成;

方法

`Request`

描述： 发送消息并接收响应的方法

输入参数：

参数名	类型	描述
`Data`	`U8[]`	请求数据
`TimeoutMs`	`S32`	超时时间
`ReqHeaderFileds`	`ReqHeaderFileds`	mctp上层协议请求报文头字段, 完成协议请求报文头的填充。目前支持, NCSI协议: 数据包类型 PacketType, 通道标识 ChannelId, 数据包标识 PackageId; NVME协议: 数据完整校验标识 IC, NVME消息类型 MsgType, 命令插槽标识 CmdSlot; PLDM协议: 报文类型 PldmType, 命令代码 CommandCode
`RspHeaderValidators`	`RspHeaderValidators`	对mctp上层协议返回报文头的校验。支持校验项: NCSI: NCSI协议返回数据包类型 PacketType; PLDM协议: 返回命令代码 CommandCode

输出参数：

参数名	类型	描述
`Data`	`U8[]`	响应数据

`Send`

描述： 发送消息的方法

输入参数：

参数名	类型	描述
`Data`	`U8[]`	请求数据
`ReqHeaderFileds`	`ReqHeaderFileds`	mctp上层协议请求报文头字段, 完成协议请求报文头的填充。目前支持, NCSI协议: 数据包类型 PacketType, 通道标识 ChannelId, 数据包标识 PackageId; NVME协议: 数据完整校验标识 IC, NVME消息类型 MsgType, 命令插槽标识 CmdSlot; PLDM协议: 报文类型 PldmType, 命令代码 CommandCode

自定义类型

ReqHeaderFileds 结构：

字段名	类型	描述
key	String
value	String

RspHeaderValidators 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.Mctp.PCIeRoutingEntry

属性

属性名	类型	可读写	信号通知	描述
`EidRangeSize`	`U8`	只读	变更广播	MCTP标准定义的路由表字段 Eid范围
`StartingEid`	`U8`	只读	变更广播	MCTP标准定义的路由表字段起始Eid
`EntryType`	`U8`	只读	变更广播	MCTP标准定义的路由表字段路由类型
`PhysTransportBindingId`	`U8`	只读	变更广播	MCTP标准定义的路由表字段物理通道绑定的Id
`MediaTypeId`	`U8`	只读	变更广播	MCTP标准定义的路由表字段物理介质类型
`PhysAddress`	`U8[]`	只读	变更广播	MCTP标准定义的路由表字段物理地址

bmc.kepler.Systems.Mctp.PCIeTransport

属性

属性名	类型	可读写	信号通知	描述
`ServiceName`	`String`	只读	变更广播	注册通道的模块名
`TargetEid`	`U8`	只读	变更广播	对端的Eid
`TargetPhyAddr`	`U16`	只读	变更广播	对端PhyAddr
`MessageType`	`U8`	只读	变更广播	协议类型

bmc.kepler.Systems.Memory

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统Id
`Name`	`String`	只读	变更广播	内存名
`DimmName`	`String`	只读	变更广播	内存槽位名
`Presence`	`U8`	只读	变更广播	内存在位状态
`CpuId`	`U8`	只读	变更广播	内存对应的cpuId
`NodeId`	`U8`	只读	变更广播	内存对应的节点Id
`ChannelId`	`U8`	只读	变更广播	内存对应的物理通道Id
`LogicalChannelId`	`U8`	只读	变更广播	内存对应的逻辑通道Id
`DimmId`	`U8`	只读	变更广播	内存对应的槽位Id
`AllowedSpeedsMHz`	`U32`	只读	变更广播	运行的最高操作频率
`BaseModuleType`	`String`	只读	变更广播	基础模块类型RDIMM、UDIMM、LRDIMM
`CapacityMiB`	`U32`	只读	变更广播	容量
`DataWidthBits`	`U32`	只读	变更广播	数据位宽
`FirmwareRevision`	`String`	只读	变更广播	固件修订版本
`Manufacturer`	`String`	只读	变更广播	制造商
`MemoryDeviceType`	`String`	只读	变更广播	内存设备类型
`MemorySubsystemControllerManufacturerID`	`String`	只读	变更广播	子系统控制器制造商Id
`MemorySubsystemControllerProductID`	`String`	只读	变更广播	子系统控制器产品Id
`MemoryType`	`String`	只读	变更广播	内存类型
`OperatingSpeedMhz`	`U32`	只读	变更广播	内存模块的时钟频率
`PartNumber`	`String`	只读	变更广播	部件号
`OriginalPartNumber`	`String`	只读	变更广播	内存的原厂部件号
`RankCount`	`U32`	只读	变更广播	Rank数
`SerialNumber`	`String`	只读	变更广播	序列号
`MinVoltageMillivolt`	`U32`	只读	变更广播	最小工作电压
`Position`	`String`	只读	变更广播	位置
`DiagnosticFault`	`U8`	读写	变更广播	严重故障诊断告警状态
`PredictiveFault`	`U8`	只读	变更广播	预故障告警状态
`DeviceLocator`	`String`	只读	变更广播	内存的丝印
`Health`	`U8`	只读	变更广播	健康状态
`DimmNum`	`U8`	只读	变更广播	DimmNum
`BOM`	`String`	只读	变更广播	物料清单
`ManufacturerID`	`String`	只读	变更广播	制造商ID
`ManufacturingDate`	`String`	只读	变更广播	生产日期
`ManufacturingLocation`	`String`	只读	变更广播	制造地点
`ChipBitWidth`	`String`	只读	变更广播	内存位宽
`TemperatureCelsius`	`Double`	只读	变更广播	内存温度
`SilkText`	`String`	只读	变更广播	内存的板上丝印
`ErrorCorrection`	`String`	只读	变更广播	内存设备支持的纠错信息，取值有AddressParity、MultiBitECC、NoECC、SingleBitECC

bmc.kepler.Systems.Memory.MemoryMetrics

属性

属性名	类型	可读写	信号通知	描述
`BandwidthPercent`	`U8`	只读	变更广播	占用率
`BandwidthThresholdPercent`	`U8`	只读	变更广播	占用率门限
`ConsumedPowerWatt`	`U32`	只读	变更广播	功耗
`SystemMemoryBuffersGiB`	`Double`	只读	变更广播	内存的缓存区容量
`SystemMemoryCachedGiB`	`Double`	只读	变更广播	内存的缓冲区容量
`TotalSystemMemoryGiB`	`Double`	只读	变更广播	内存的总容量

方法

`SetBandwidthThreshold`

描述： 设置内存占用率门限

输入参数：

参数名	类型	描述
`BandwidthThresholdPercent`	`U8`	内存占用率门限

输出参数：

参数名	类型	描述
`Result`	`S32`	设置内存占用率门限结果

`GetBandwidthHistory`

描述： 获取内存占用率的历史数据

输出参数：

参数名	类型	描述
`History`	`String`	内存占用率的历史数据

`ClearBandwidthHistory`

描述： 清除内存占用率的历史数据

bmc.kepler.Systems.MemoryChannel

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	内存通道名
`LogicalCpuId`	`U8`	只读	变更广播	逻辑cpuId
`PhysicalChannelId`	`U8`	只读	变更广播	物理内存通道Id
`LogicalChannelId`	`U8`	只读	变更广播	逻辑内存通道Id
`DiagnosticFault`	`U8`	读写	变更广播	严重故障诊断告警状态
`SystemId`	`U8`	只读	变更广播	系统Id

bmc.kepler.Systems.NCSICapabilities

属性

属性名	类型	可读写	信号通知	描述
`PCIeNCSIEnabled`	`U8`	只读	变更广播	PCIE标卡NCSI线缆在位标记
`PCIeNCSISupported`	`Boolean`	只读	变更广播	用于生产查询主板对PCIE标卡NCSI功能支持能力

bmc.kepler.Systems.NPUCard

属性

属性名	类型	可读写	信号通知	描述
`PowerWatts`	`U16`	只读	变更广播	功耗
`PowerState`	`U8`	只读	变更广播	NPU卡电源状态，1表示上电，0表示下电
`Core0TemperatureCelsius`	`U16`	只读	变更广播	芯片1温度
`Core1TemperatureCelsius`	`U16`	只读	变更广播	芯片2温度
`OutletTemperatureCelsius`	`U16`	只读	变更广播	NPU卡出风口温度
`InletTemperatureCelsius`	`U16`	只读	变更广播	NPU卡出风口温度
`FaultState`	`U32`	只读	变更广播	NPU卡的故障状态
`FaultCode`	`String`	只读	变更广播	NPU卡的故障码
`McuFirmwareVersion`	`String`	只读	变更广播	NPU卡的MCU版本
`SlotNumber`	`U32`	只读	变更广播	NPU卡的槽位
`SerialNumber`	`String`	只读	变更广播	NPU卡的序列号
`BoardID`	`U16`	只读	变更广播	NPU卡的board id
`PcbVersion`	`String`	只读	变更广播	NPU卡的pcb版本
`Name`	`String`	只读	变更广播	NPU卡的名称
`FirmwareVersion`	`String`	只读	变更广播	系统固件版本
`MemoryCapacityMiB`	`U32`	只读	变更广播	内存容量，单位（MB）

bmc.kepler.Systems.NPUFDMService

属性

属性名	类型	可读写	信号通知	描述
`HbmFPCEnabled`	`Boolean`	读写	变更广播	NPU HBM FPC总开关
`HbmFaultIsolationEnabled`	`Boolean`	读写	变更广播	NPU HBM隔离修复总开关
`HbmPageOfflineEnabled`	`Boolean`	读写	变更广播	NPU HBM pageoffline开关

bmc.kepler.Systems.NetworkAdapter

属性

属性名	类型	可读写	信号通知	描述
`ID`	`String`	只读	变更广播	网卡ID
`SystemID`	`U8`	只读	变更广播	系统ID
`Name`	`String`	只读	变更广播	网卡型号名称
`DisplayName`	`String`	只读	变更广播	网卡显示名称
`Manufacturer`	`String`	只读	变更广播	厂商名称
`Description`	`String`	只读	变更广播	网卡描述
`Position`	`String`	只读	变更广播	网卡容器信息
`DeviceLocator`	`String`	只读	变更广播	网卡丝印信息
`Type`	`U8`	只读	变更广播	网卡类型
`NetworkPortCount`	`U8`	只读	变更广播	网口个数
`Model`	`String`	只读	变更广播	芯片型号
`ChipVendor`	`String`	只读	变更广播	芯片厂商
`ModelDescription`	`String`	只读	变更广播	芯片型号描述
`ChipManufacturer`	`String`	只读	变更广播	芯片厂商
`DriverName`	`String`	只读	变更广播	驱动名称
`DriverVersion`	`String`	只读	变更广播	驱动版本
`SlotNumber`	`U8`	只读	变更广播	槽位号
`NetDevFuncCapabilities`	`U8`	只读	变更广播	网卡支持的协议，0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
`RootBDF`	`String`	只读	变更广播	网卡BDF信息
`FirmwareVersion`	`String`	只读	变更广播	固件版本
`VendorID`	`String`	只读	变更广播	厂商ID
`DeviceID`	`String`	只读	变更广播	设备ID
`SubsystemVendorID`	`String`	只读	变更广播	子系统厂商ID
`SubsystemDeviceID`	`String`	只读	变更广播	子系统设备ID
`BoardID`	`U16`	只读	变更广播	单板ID
`BoardName`	`String`	只读	变更广播	单板名称
`BoardIDHex`	`String`	只读	变更广播	十六进制单板ID
`ComponentUniqueID`	`String`	只读	变更广播	组件唯一标识
`PCBVersion`	`String`	只读	变更广播	PCB版本
`AssociatedResource`	`String`	只读	变更广播	网卡资源归属
`SupportedMctp`	`Boolean`	只读	变更广播	网卡是否支持MCTP
`HotPluggable`	`Boolean`	只读	变更广播	网卡是否支持热插拔
`ReadyToRemove`	`Boolean`	只读	变更广播	热拔出是否已准备好
`AttentionHotPlugState`	`U8`	只读	变更广播	热插拔状态：0 - 不可操作；1 - 可拔出；2 - 可插入；其他 - 未知
`SerialNumber`	`String`	只读	变更广播	序列号
`PreviousSerialNumber`	`String`	只读	变更广播	更换前的序列号
`TemperatureCelsius`	`S16`	只读	变更广播	芯片温度
`TemperatureStatus`	`U8`	只读	变更广播	芯片温度状态：0 - 正常；1 - 失效
`LLDPSupported`	`Boolean`	只读	变更广播	网卡是否支持LLDP
`FruId`	`U8`	只读	变更广播	网卡电子标签
`PredictiveFault`	`U8`	读写	变更广播	预测故障标志位
`DiagnosticFault`	`U8`	读写	变更广播	故障诊断定位标志位
`ReplacedFlag`	`U8`	只读	变更广播	网卡更换标志位
`SupportedLLDP`	`Boolean`	只读	变更广播	网卡是否支持LLDP
`ParentCardSlotId`	`U8`	只读	变更广播	关联上一级卡的槽位号
`PfMacInfo`	`Array`	只读	变更广播	Physical Function Mac信息
`BandwidthThresholdPercent`	`U16`	只读	变更广播	网络带宽占用率门限
`NodeId`	`String`	只读	变更广播	网卡NodeId

方法

`StartRemovingDevice`

描述： 启动设备热拔

输入参数：

参数名	类型	描述
`ID`	`String`	设备号

`DumpBlackBox`

描述： 收集黑匣子日志,当前仅SDI 5.1的网络卡支持

输入参数：

参数名	类型	描述
`Path`	`String`	日志保存路径

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

自定义类型

PfMacInfoItem 结构：

字段名	类型	描述
Port	U16	Physical Function Port信息
PfId	U16	Physical Function Id信息
PermanentMac	String	永久物理地址信息

bmc.kepler.Systems.NetworkAdapter.NetworkAdapterMetrics

属性

属性名	类型	可读写	信号通知	描述
`LinkWidthCapability`	`String`	只读	变更广播	网卡支持的最大带宽能力
`LinkSpeedCapability`	`String`	只读	变更广播	网卡支持的最大速率能力
`LinkWidth`	`String`	只读	变更广播	网卡实际带宽
`LinkSpeed`	`String`	只读	变更广播	网卡实际速率
`SFPMaxTemperatureCelsius`	`S16`	只读	变更广播	光模块最大温度,用于调速,单位:摄氏度

bmc.kepler.Systems.NetworkAdapter.Status

属性

属性名	类型	可读写	信号通知	描述
`Health`	`U8`	只读	变更广播	网卡健康状态, 0:OK, 1:Minor, 2:Major, 3:Critical
`FaultCode`	`String`	只读	变更广播	异常码
`FaultState`	`U32`	只读	变更广播	故障状态，用于告警配置

bmc.kepler.Systems.NetworkAdapters

方法

`GetNetCardPortNum`

描述： 获取网卡端口资源数量

输入参数：

参数名	类型	描述
`Type`	`U8`	网口类型
`SystemID`	`U8`	系统系列号
`SlotID`	`U8`	槽位号

输出参数：

参数名	类型	描述
`NetcardExist`	`U8`	网卡在位信息
`PortNum`	`U8`	网口数量

`GetPortSpeed`

描述： 获取网口速率

输入参数：

参数名	类型	描述
`Type`	`U8`	网口类型
`Slot`	`U8`	槽位号
`PortID`	`U8`	网卡端口号

输出参数：

参数名	类型	描述
`Status`	`U8`	网口连接状态
`Speed`	`U32`	网口速率

`GetNetworkAdapterNum`

描述： 获取网卡数量

输出参数：

参数名	类型	描述
`NetworkAdapterNum`	`U8`	网卡数量

`GetNetworkPortNum`

描述： 获取网口总数量

输出参数：

参数名	类型	描述
`NetworkPortNum`	`U8`	网口数量

`GetBandwidthHistory`

描述： 获取各个网卡的端口带宽占用率历史数据

输出参数：

参数名	类型	描述
`History`	`String`	网口占用率历史数据

`ClearBandwidthHistory`

描述： 清空各个网卡的端口带宽占用率历史数据

输入参数：

参数名	类型	描述
`BWUWaveTitle`	`String`	网卡名称

`SetBandwidthThreshold`

描述： 设置网络带宽占用率门限

输入参数：

参数名	类型	描述
`BandwidthThresholdPercent`	`U8`	占用率阈值，用于设置网口历史占用率

输出参数：

参数名	类型	描述
`Result`	`S32`	函数调用结果

bmc.kepler.Systems.NetworkBonding

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	Bonding ID, 由BMA获取bonding资源时生成
`Name`	`String`	只读	变更广播	Bonding 名称, 在创建bonding资源时生成

bmc.kepler.Systems.NetworkBondings

方法

`CreateBond`

描述： 创建新Bond

输入参数：

参数名	类型	描述
`Request`	`Object`	创建bond需要的参数, 如port、BondingType等

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务Id

`DeleteBond`

描述： 删除指定Bond

输入参数：

参数名	类型	描述
`Id`	`String`	待删除的Bond Id

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务Id

`SetLinkMonitorPeriodMS`

描述： 设置Bond的链路监控周期

输入参数：

参数名	类型	描述
`Id`	`String`	待设置的Bond Id
`LinkMonitorPeriodMS`	`U32`	链路监控周期

输出参数：

参数名	类型	描述
`TaskId`	`U32`	创建的任务Id

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.NetworkBridge

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	网桥ID
`Name`	`String`	只读	变更广播	网桥名称

bmc.kepler.Systems.NetworkPort

属性

属性名	类型	可读写	信号通知	描述
`SystemID`	`U8`	只读	变更广播	系统ID
`NodeId`	`String`	只读	变更广播	网口NodeId
`Name`	`String`	只读	变更广播	网口名称
`Type`	`U8`	只读	变更广播	网口类型
`PortID`	`U8`	只读	变更广播	网口ID
`PermanentMACAddress`	`String`	只读	变更广播	永久MAC地址
`MACAddress`	`String`	只读	变更广播	MAC地址
`LinkStatus`	`String`	读写	变更广播	链路状态
`LinkStatusNumeric`	`U8`	读写	变更广播	链路状态
`IPv6DefaultGateway`	`String`	只读	变更广播	IPv6默认网关
`WorkMode`	`String`	只读	变更广播	工作模式
`FunctionType`	`String`	只读	变更广播	网口类型:物理,虚拟
`BDF`	`String`	只读	变更广播	网口BDF
`AutoConnectOnBoot`	`Boolean`	只读	变更广播	开机是否自动启用网络连接
`NetDevFuncType`	`U8`	只读	变更广播	网络设备功能类型，0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
`MediumType`	`String`	只读	变更广播	网口介质类型
`SpeedMbps`	`U32`	只读	变更广播	链路速率
`FullDuplex`	`Boolean`	只读	变更广播	是否开启全双工
`AutoSpeedNegotiation`	`Boolean`	只读	变更广播	是否处于自协商模式
`FirmwareVersion`	`String`	只读	变更广播	固件版本
`DriverName`	`String`	只读	变更广播	驱动名称
`DriverVersion`	`String`	只读	变更广播	驱动版本
`LLDPEnabled`	`Boolean`	读写	变更广播	网口LLDP使能 false:关闭使能 true:打开使能
`SupportedLinkCapability`	`String`	只读	变更广播	支持的传输速率
`NetworkAdapterId`	`String`	只读	变更广播	对应的网卡ID属性
`LinkMonitorPeriodMS`	`U32`	只读	变更广播	网口链路监测周期，单位毫秒
`UUID`	`String`	只读	变更广播	网口全球唯一标识，用于IB卡。只读属性，默认为空。
`WorkloadType`	`U8`	只读	变更广播	工作负载类型，0：负载服务器os；1：负载智能网卡的os；2：服务器os及智能网卡os均卸载

方法

`Configure`

描述： 配置网口

输入参数：

参数名	类型	描述
`Request`	`Object`	配置网口时传入的参数列表,如连接状态、地址、掩码等

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.NetworkPort.DataCenterBridging

属性

属性名	类型	可读写	信号通知	描述
`Up2cos`	`U8[]`	只读	变更广播	DCB 信息中的 Up2cos
`Uppgid`	`U8[]`	只读	变更广播	DCB 信息中的 Uppgid
`Pgpct`	`U8[]`	只读	变更广播	DCB 信息中的 Pgpct
`PgStrict`	`U8[]`	只读	变更广播	DCB 信息中的 PgStrict
`Pfcmap`	`U8`	只读	变更广播	DCB 信息中的 Pfcmap

bmc.kepler.Systems.NetworkPort.FibreChannel

属性

属性名	类型	可读写	信号通知	描述
`FCId`	`String`	只读	变更广播	FC ID信息
`WWNN`	`String`	只读	变更广播	当前生效WWNN号
`PermanentWWNN`	`String`	只读	变更广播	出厂WWNN号
`WWPN`	`String`	只读	变更广播	当前生效WWPN号
`PermanentWWPN`	`String`	只读	变更广播	出厂WWPN号
`SpeedGbps`	`U32`	只读	变更广播	端口链接速率，单位Gb，用于FC卡

bmc.kepler.Systems.NetworkPort.LLDPReceive

属性

属性名	类型	可读写	信号通知	描述
`ChassisId`	`String`	只读	变更广播	从网络交换机接收到的Chassis ID
`ChassisIdSubtype`	`String`	只读	变更广播	从网络交换机接收到的Chassis ID类型
`PortId`	`String`	只读	变更广播	从网络交换机接收到的端口ID
`PortIdSubtype`	`String`	只读	变更广播	从网络交换机接收到的端口ID类型
`SystemName`	`String`	只读	变更广播	网络交换机名称
`ManagementVlanId`	`U16`	只读	变更广播	从网络交换机接收到的VLAN ID

bmc.kepler.Systems.NetworkPort.Metrics

属性

属性名	类型	可读写	信号通知	描述
`RXFrames`	`String`	只读	变更广播	收到的帧数量
`TXFrames`	`String`	只读	变更广播	发送的帧数量
`PacketsDropped`	`U64`	只读	变更广播	丢包总数
`RXUnicastFrames`	`String`	只读	变更广播	收到的单播帧数量
`RXMulticastFrames`	`String`	只读	变更广播	收到的多播帧数量
`RXBroadcastFrames`	`String`	只读	变更广播	收到的广播帧数量
`TXUnicastFrames`	`String`	只读	变更广播	发送的单播帧数量
`TXMulticastFrames`	`String`	只读	变更广播	发送的多播帧数量
`TXBroadcastFrames`	`String`	只读	变更广播	发送的广播帧数量
`RXFCSErrors`	`String`	只读	变更广播	接收到的校验错误帧数量
`RXUndersizeFrames`	`String`	只读	变更广播	接收到的超小帧数量
`RXOversizeFrames`	`String`	只读	变更广播	接收到的超长帧数量
`TXSingleCollisions`	`String`	只读	变更广播	发送的单碰撞帧数量
`TXMultipleCollisions`	`String`	只读	变更广播	发送的多碰撞帧数量
`TXLateCollisions`	`String`	只读	变更广播	发送的延迟碰撞帧数量
`TXExcessiveCollisions`	`String`	只读	变更广播	发送的超量碰撞帧数量
`RXFrameAlignmentErrors`	`String`	只读	变更广播	接收的对齐错误的帧数量
`BandwidthUsagePercent`	`Double`	只读	变更广播	网络带宽占用率

bmc.kepler.Systems.NetworkPort.VLAN

属性

属性名	类型	可读写	信号通知	描述
`VLANId`	`U16`	只读	变更广播	VLAN ID
`VLANEnabled`	`Boolean`	只读	变更广播	VLAN是否启用
`VLANPriority`	`U8`	只读	变更广播	VLAN优先级
`AutoConnectOnBoot`	`Boolean`	只读	变更广播	VLAN是否在系统启动时自动创建和启用

方法

`ConfigureVLAN`

描述： 配置网口VLAN

输入参数：

参数名	类型	描述
`Request`	`Object`	配置参数列表

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`DeleteVLAN`

描述： 删除网口VLAN

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.NetworkPort.VLANs

方法

`CreateVLAN`

描述： 创建VLAN

输入参数：

参数名	类型	描述
`Request`	`Object`	创建vlan参数列表

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.Systems.OSConfiguration

属性

属性名	类型	可读写	信号通知	描述
`CpuFrequencyMHz`	`Array`	只读	变更广播	设置CPU Numa/Core频率(MHZ)
`MsgMax`	`U32`	只读	变更广播	消息队列中单个消息的最大字节数
`CFSBandwidthSliceUS`	`U32`	只读	变更广播	CFS带宽控制
`NrMigrate`	`U32`	只读	变更广播	负载平衡可跨处理器迁移的任务数
`MigrationCostNS`	`U32`	只读	变更广播	任务迁移阈值
`MinGranularityNS`	`U32`	只读	变更广播	CPU上进程的最短运行时间
`Swappiness`	`U8`	只读	变更广播	swap的物理内存剩余空间百分比阈值
`DirtyRatio`	`U8`	只读	变更广播	脏数据提交阈值

方法

`SetCpuFrequencyMHz`

描述： 设置设置CPU Numa/Core频率(MHZ)

输入参数：

参数名	类型	描述
`CpuFrequencyMHz`	`Array`	设置CPU Numa/Core频率(MHZ)

`SetMsgMax`

描述： 设置消息队列中单个消息的最大字节数

输入参数：

参数名	类型	描述
`MsgMax`	`U32`	消息队列中单个消息的最大字节数

`SetCFSBandwidthSliceUS`

描述： 设置CFS带宽控制

输入参数：

参数名	类型	描述
`CFSBandwidthSliceUS`	`U32`	CFS带宽控制

`SetNrMigrate`

描述： 设置负载平衡可跨处理器迁移的任务数

输入参数：

参数名	类型	描述
`NrMigrate`	`U32`	负载平衡可跨处理器迁移的任务数

`SetMigrationCostNS`

描述： 设置任务迁移阈值

输入参数：

参数名	类型	描述
`MigrationCostNS`	`U32`	任务迁移阈值

`SetMinGranularityNS`

描述： 设置CPU上进程的最短运行时间

输入参数：

参数名	类型	描述
`MinGranularityNS`	`U32`	CPU上进程的最短运行时间

`SetSwappiness`

描述： 设置swap的物理内存剩余空间百分比阈值

输入参数：

参数名	类型	描述
`Swappiness`	`U8`	swap的物理内存剩余空间百分比阈值

`SetDirtyRatio`

描述： 设置脏数据提交阈值

输入参数：

参数名	类型	描述
`DirtyRatio`	`U8`	脏数据提交阈值

自定义类型

CpuFrequencyData 结构：

字段名	类型	描述
NUMA	U8
CORE	U32[]

bmc.kepler.Systems.OpticalModule

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	名称
`Manufacturer`	`String`	只读	变更广播	厂商名称
`PartNumber`	`String`	只读	变更广播	厂商部件名称
`SerialNumber`	`String`	只读	变更广播	序列号
`ProductionDate`	`String`	只读	变更广播	生产日期
`TransceiverType`	`String`	只读	变更广播	收发器类型
`FiberConnectionType`	`String`	只读	变更广播	传输模式
`WaveLengthNanometer`	`String`	只读	变更广播	波长，单位纳米
`Type`	`String`	只读	变更广播	类型
`SupportedSpeedsMbps`	`Double[]`	只读	变更广播	支持的速率
`Health`	`U8`	只读	变更广播	健康状态
`Identifier`	`String`	只读	变更广播	识别码
`ConnectorType`	`String`	只读	变更广播	连接器类型
`MediumType`	`String`	只读	变更广播	介质类型
`TransmissionDistance`	`String`	只读	变更广播	传输距离
`RxLossState`	`Boolean`	只读	变更广播	发送端信号是否丢失
`TxLossState`	`Boolean`	只读	变更广播	接收端信号是否丢失
`TxFaultState`	`Boolean`	只读	变更广播	接收端是否故障
`TypeMatch`	`Boolean`	只读	变更广播	类型是否匹配
`SpeedMatch`	`Boolean`	只读	变更广播	速率是否匹配
`FaultState`	`U32`	只读	变更广播	故障状态
`TemperatureCelsius`	`Double`	只读	变更广播	光模块温度（用于告警）
`PowerState`	`U8`	只读	变更广播	功率异常标志位（用于告警）
`IsSupportedType`	`U8`	只读	变更广播	网卡支持速率与光模块速率不匹配标志位（用于告警）
`Presence`	`U8`	只读	变更广播	光模块是否在位
`ChannelNum`	`U8`	只读	变更广播	光模块内部通道数
`RxSNR`	`Double[]`	只读	变更广播	端口接收信噪比
`HostSNR`	`Double[]`	只读	变更广播	主机侧信噪比
`MediaSNR`	`Double[]`	只读	变更广播	介质侧信噪比
`Accessible`	`U8`	只读	变更广播	光模块是否可访问,0为不可访问,1为可访问

bmc.kepler.Systems.OpticalModule.BiasCurrent

属性

属性名	类型	可读写	信号通知	描述
`TXBiasCurrentMilliAmps`	`Double[]`	只读	变更广播	读取的电流，单位毫安
`TXBiasCurrent1MilliAmps`	`Double`	只读	变更广播	读取的通道1的电流，单位毫安
`TXBiasCurrent2MilliAmps`	`Double`	只读	变更广播	读取的通道2的电流，单位毫安
`TXBiasCurrent3MilliAmps`	`Double`	只读	变更广播	读取的通道3的电流，单位毫安
`TXBiasCurrent4MilliAmps`	`Double`	只读	变更广播	读取的通道4的电流，单位毫安
`TXBiasCurrent5MilliAmps`	`Double`	只读	变更广播	读取的通道5的电流，单位毫安
`TXBiasCurrent6MilliAmps`	`Double`	只读	变更广播	读取的通道6的电流，单位毫安
`TXBiasCurrent7MilliAmps`	`Double`	只读	变更广播	读取的通道7的电流，单位毫安
`TXBiasCurrent8MilliAmps`	`Double`	只读	变更广播	读取的通道8的电流，单位毫安
`TXBiasCurrentStatus`	`U32`	只读	变更广播	偏置电流异常状态;每个bit对应一个通道,某个bit取值1表示是对应偏置电流通道故障;当前光模块最多8通道,属性预留32位便于扩展
`TXLowerThresholdCritical`	`Double`	只读	变更广播	发送偏置电流告警下限阈值
`TXUpperThresholdCritical`	`Double`	只读	变更广播	发送偏置电流告警上限阈值
`BiasCurrentTXUpperThresholdWarning`	`Double`	只读	变更广播	发送偏置电流警告上限阈值
`BiasCurrentTXLowerThresholdWarning`	`Double`	只读	变更广播	发送偏置电流警告下限阈值

bmc.kepler.Systems.OpticalModule.Channel

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	光模块RX/TX通道号
`BiasCurrentMilliAmps`	`Double`	只读	变更广播	通道的偏置电流，单位毫安
`RXPowerMilliWatts`	`Double`	只读	变更广播	通道的接收功率，单位毫瓦
`TXPowerMilliWatts`	`Double`	只读	变更广播	通道的发送功率，单位毫瓦

bmc.kepler.Systems.OpticalModule.Diagnose

属性

属性名	类型	可读写	信号通知	描述
`RxLossOfLock`	`U8`	只读	变更广播	接受方向的CDR失败状态
`TxLossOfLock`	`U8`	只读	变更广播	发送方向的CDR失败状态
`LaserRuntimeSeconds`	`U32`	只读	变更广播	激光器运行时间,单位:秒
`LaserTemperatureCelsius`	`Double`	只读	变更广播	激光器管芯温度
`PowerOnCount`	`U16`	只读	变更广播	模块上电次数
`UptimeSeconds`	`U32`	只读	变更广播	模块上电时间,单位:秒
`PowerStatus`	`U16`	只读	变更广播	模块上电状态
`OdspDieTemperatureCelsius`	`Double`	只读	变更广播	ODSP结温
`OdspHighTempRuntimeSeconds`	`U32`	只读	变更广播	ODSP高温运行时间,单位:秒
`SelfTestStatus`	`U64`	只读	变更广播	光模块自体诊断告警状态,轻微隐患和严重故障各32bit
`MediaInterfaceFaultStatus`	`U16`	只读	变更广播	光链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
`HostInterfaceFaultStatus`	`U16`	只读	变更广播	电链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
`RxLoS`	`U32`	只读	变更广播	接收端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
`TxLoS`	`U32`	只读	变更广播	发送端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
`TxFault`	`U32`	只读	变更广播	发送错误;每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
`PRBSTestSupported`	`Boolean`	只读	变更广播	此光模块是否支持PRBS压测
`FiberDirtyDetected`	`Boolean`	读写	变更广播	光模块是否脏污
`FiberLoosenessDetected`	`Boolean`	读写	变更广播	光模块是否松动

bmc.kepler.Systems.OpticalModule.Power

属性

属性名	类型	可读写	信号通知	描述
`RXInputPowerMilliWatts`	`Double[]`	只读	变更广播	读取的接收功率，单位毫瓦
`RXInputPowerStatus`	`U32`	只读	变更广播	接收功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应接收功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
`RXLowerThresholdCritical`	`Double`	只读	变更广播	接收功率告警下限阈值
`RXUpperThresholdCritical`	`Double`	只读	变更广播	接收功率告警上限阈值
`TXOutputPowerMilliWatts`	`Double[]`	只读	变更广播	读取的发送功率，单位毫瓦
`TXOutputPowerStatus`	`U32`	只读	变更广播	发送功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应发送功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
`TXLowerThresholdCritical`	`Double`	只读	变更广播	发送功率告警下限阈值
`TXUpperThresholdCritical`	`Double`	只读	变更广播	发送功率告警上限阈值
`PowerTXUpperThresholdWarning`	`Double`	只读	变更广播	发送功率警告上限阈值
`PowerTXLowerThresholdWarning`	`Double`	只读	变更广播	发送功率警告下限阈值
`PowerRXUpperThresholdWarning`	`Double`	只读	变更广播	接收功率警告上限阈值
`PowerRXLowerThresholdWarning`	`Double`	只读	变更广播	接收功率警告下限阈值

bmc.kepler.Systems.OpticalModule.Temperature

属性

属性名	类型	可读写	信号通知	描述
`ReadingCelsius`	`Double`	只读	变更广播	读取的芯片温度
`LowerThresholdCritical`	`Double`	只读	变更广播	下限阈值
`UpperThresholdCritical`	`Double`	只读	变更广播	上限阈值
`TemperatureLowerThresholdCritical`	`Double`	只读	变更广播	低温告警阈值
`TemperatureUpperThresholdCritical`	`Double`	只读	变更广播	高温告警阈值
`TemperatureLowerThresholdWarning`	`Double`	只读	变更广播	低温警告阈值
`TemperatureUpperThresholdWarning`	`Double`	只读	变更广播	高温警告阈值

bmc.kepler.Systems.OpticalModule.Voltage

属性

属性名	类型	可读写	信号通知	描述
`SupplyVoltage`	`Double`	只读	变更广播	供电电压
`LowerThresholdCritical`	`Double`	只读	变更广播	下限阈值
`UpperThresholdCritical`	`Double`	只读	变更广播	上限阈值
`VoltageLowerThresholdCritical`	`Double`	只读	变更广播	低压告警阈值
`VoltageUpperThresholdCritical`	`Double`	只读	变更广播	高压告警阈值
`VoltageLowerThresholdWarning`	`Double`	只读	变更广播	低压警告阈值
`VoltageUpperThresholdWarning`	`Double`	只读	变更广播	高压警告阈值

bmc.kepler.Systems.PCIeDevices

方法

`SetPcieErrorStatus`

描述： 根据错误类型设置不同错误事件属性状态

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	PCIe设备所属CPU ID
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`ErrorType`	`String`	错误类型：CorrectableError可纠正错误、UncorrectableError不可纠正错误、FatalError致命错误、ParityError奇偶校验错误、SystemError系统错误
`Value`	`U8`	PCIe设备是否发生错误, 取值: 0-未发生,1-发生

输出参数：

参数名	类型	描述
`Status`	`U8`	错误事件属性状态

`SetBandwidthReduction`

描述： 设置PCIE降带宽事件属性

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`Value`	`U8`	带宽事件属性值

输出参数：

参数名	类型	描述
`Status`	`U8`	设置降带宽事件属性状态

`SetUCEByBIOS`

描述： 设置PCIE设备BIOS上报的UCE故障

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`Value`	`U8`	上报的UCE故障值

输出参数：

参数名	类型	描述
`Status`	`U8`	设置上报的UCE故障状态

`SetDiagnosticFault`

描述： 设置故障标志位

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	PCIe设备所属CPU ID
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`Value`	`U8`	故障标志位值

输出参数：

参数名	类型	描述
`Status`	`U8`	设置故障标志位状态

`SetPredictiveFault`

描述： 设置预故障告警标志位

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	PCIe设备所属CPU ID
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`Value`	`U8`	预故障告警标志位值

输出参数：

参数名	类型	描述
`Status`	`U8`	预故障告警标志位状态

`GetDeviceName`

描述： 根据SSBDF获取设备丝印名

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	PCIe设备所属CPU ID
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号

输出参数：

参数名	类型	描述
`Status`	`U8`	获取设备丝印名状态
`DeviceName`	`String`	设备丝印名称

`GetPCIeCardNum`

描述： 获取pcie卡数量

输出参数：

参数名	类型	描述
`PCIeCardNum`	`U32`	PCIe卡数量

`SetFaultByBios`

描述： 设置PCIERAID卡BIOS上报故障状态

输入参数：

参数名	类型	描述
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`FaultStatus`	`U8`	PCIe 卡故障状态

输出参数：

参数名	类型	描述
`Status`	`U8`	设置PCIERAID卡BIOS上报故障状态

`SetLinkSpeedReduced`

描述： 设置PCIe设备降速率事件属性

输入参数：

参数名	类型	描述
`Segment`	`U8`	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号
`Value`	`U8`	PCIe设备降速率事件属性值

输出参数：

参数名	类型	描述
`Status`	`U8`	设置PCIe设备降速率事件属性状态

bmc.kepler.Systems.PCIeDevices.EthDevice

属性

属性名	类型	可读写	信号通知	描述
`PortId`	`U8`	只读	变更广播	网口的物理编号，每张网卡从0开始
`LaneId`	`U8`	只读	变更广播	网口的逻辑lane编号，每张网卡从0开始
`Segment`	`U8`	只读	变更广播	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	只读	变更广播	网卡对应的CPU ID
`ControllerIndex`	`U8`	只读	变更广播	网卡对应的Eth控制器ID
`Bus`	`U8`	只读	变更广播	网口设备的Bus
`Device`	`U8`	只读	变更广播	网口设备的Device
`Function`	`U8`	只读	变更广播	网口设备的Function
`PortFunctionId`	`U8`	只读	变更广播	网口设备的PortFunctionId

bmc.kepler.Systems.PCIeDevices.PCIeCard

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	产品名称（SP580等）
`SlotID`	`U8`	只读	变更广播	槽位号
`DeviceName`	`String`	只读	变更广播	设备资源名称
`FunctionClass`	`U8`	只读	变更广播	功能分类（0:未知、1:RAID、2:网卡、3:GPU卡、4:存储卡（SSD卡/M.2卡）、5:SDI卡、6:加速卡、7:扩展卡（PCIe Riser）、8:FPGA卡、9:NPU卡）
`Description`	`String`	只读	变更广播	描述
`PcbVersion`	`String`	只读	变更广播	PCB版本
`BoardID`	`U16`	只读	变更广播	单板ID（仅自研卡涉及）
`BoardName`	`String`	只读	变更广播	单板名称（仅自研卡涉及）
`LinkWidthAbility`	`String`	只读	变更广播	最大链路带宽
`LinkWidth`	`String`	只读	变更广播	链路带宽
`LinkSpeedCapability`	`String`	只读	变更广播	最大链路速率
`LinkSpeed`	`String`	只读	变更广播	链路速率
`VendorID`	`U16`	只读	变更广播	制造商ID
`DeviceID`	`U16`	只读	变更广播	设备ID
`SubVendorID`	`U16`	只读	变更广播	子厂商ID
`SubDeviceID`	`U16`	只读	变更广播	子设备ID
`Position`	`String`	只读	变更广播	位置信息(容器信息)
`Manufacturer`	`String`	只读	变更广播	厂商
`LaneOwner`	`U8`	只读	变更广播	资源归属，起始值为1，表示当前卡挂在哪个CPU下
`FirmwareVersion`	`String`	只读	变更广播	固件版本
`PartNumber`	`String`	只读	变更广播	部件编码
`SerialNumber`	`String`	只读	变更广播	序列号
`RefComponent`	`String`	只读	变更广播	关联部件对象
`Health`	`U8`	只读	变更广播	健康状态
`Model`	`String`	只读	变更广播	PCIe卡的型号
`NodeID`	`String`	只读	变更广播	通过PCIe卡所在容器和槽位得到的唯一标识符
`Presence`	`U8`	只读	变更广播	在位状态
`CardModel`	`String`	只读	变更广播	PCIe设备型号
`CardManufacturer`	`String`	只读	变更广播	PCIe设备制造商
`CardForServers`	`U8[]`	只读	变更广播	PCIe设备服务的系统Id列表

bmc.kepler.Systems.PCIeDevices.PCIeDevice

属性

属性名	类型	可读写	信号通知	描述
`SlotID`	`U8`	只读	变更广播	槽位号
`Segment`	`U8`	只读	变更广播	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`SocketID`	`U8`	只读	变更广播	CPU ID
`Bus`	`U8`	只读	变更广播	root port Bus
`Device`	`U8`	只读	变更广播	root port Device
`Function`	`U8`	只读	变更广播	root port Function
`DevBus`	`U8`	只读	变更广播	设备总线
`DevDevice`	`U8`	只读	变更广播	设备的 Device
`DevFunction`	`U8`	只读	变更广播	设备的 Function
`DiagnosticFault`	`U8`	只读	变更广播	严重故障诊断告警状态
`PredictiveFault`	`U8`	只读	变更广播	预故障告警状态
`UCEByBIOS`	`U8`	只读	变更广播	BIOS上报不可纠正错误标识，相当于V2 fatalerror
`BandwidthReduction`	`U8`	只读	变更广播	PCIE降带宽检测失败上报事件属性
`LinkSpeedReduced`	`U8`	只读	变更广播	PCIe设备降速率检测告警上报事件属性(BIOS上报)
`FunctionClass`	`U8`	只读	变更广播	PCIEe设备的功能分类
`DeviceName`	`String`	只读	变更广播	设备资源名称
`Position`	`String`	只读	变更广播	设备位置（容器名称）
`FaultByBios`	`U8`	只读	变更广播	Bios上报的异常状态
`SlotType`	`String`	只读	变更广播	PCIe槽位类型
`FunctionProtocol`	`String`	只读	变更广播	PCIe功能协议
`FunctionType`	`String`	只读	变更广播	PCIe功能类型
`PCIeType`	`String`	只读	变更广播	PCIe设备所在槽位使用的规范版本
`PCIeDeviceType`	`String`	只读	变更广播	PCIe设备类型

bmc.kepler.Systems.PCIeDevices.PCIeDevice.RAS

属性

属性名	类型	可读写	信号通知	描述
`CorrectableError`	`U8`	只读	变更广播	PCIe设备发生可纠正错误, 取值: 0-未发生, 1-发生
`UncorrectableError`	`U8`	只读	变更广播	PCIe设备发生不可纠正错误, 取值: 0-未发生,1-发生
`FatalError`	`U8`	只读	变更广播	PCIe设备发生致命错误, 取值: 0-未发生,1-发生
`ParityError`	`U8`	只读	变更广播	PCIe设备发生奇偶校验错误, 取值: 0-未发生,1-发生
`SystemError`	`U8`	只读	变更广播	PCIe设备发生系统错误, 取值: 0-未发生,1-发生

bmc.kepler.Systems.PcieAddrInfo

属性

属性名	类型	可读写	信号通知	描述
`GroupID`	`U8`	只读	变更广播	逻辑组ID
`SlotID`	`U8`	只读	变更广播	槽位id
`PortID`	`U8`	只读	变更广播	pcie槽位对应的portId，用于上报bios槽位与portid对应的关系，计算对应槽位的rootBDF
`ComponentType`	`U8`	只读	变更广播	部件类型，与Component类的中的部件类型属性对应。（标准定义，如：8:PCIe标卡、13:NCI卡、83:OCP卡）
`ControllerIndex`	`U8`	只读	变更广播	PCIe控制器索引，CPU内部同类型控制器的索引，从0开始编号
`ControllerType`	`U8`	只读	变更广播	PCIe控制器类型（0:PCIeCore，1:NIC，2:SAS，3:SATA，4:ZIP，5:SEC）
`SocketID`	`U8`	只读	变更广播	CPU ID
`Segment`	`U8`	只读	变更广播	用于多PCI Bridge场景的编号，每一个Segment对应一个PCI Bus空间
`Bus`	`U8`	只读	变更广播	root port Bus号
`Device`	`U8`	只读	变更广播	root port Device号
`Function`	`U8`	只读	变更广播	root port Function号
`VendorID`	`U16`	只读	变更广播	供应商id
`DeviceID`	`U16`	只读	变更广播	设备id

bmc.kepler.Systems.Pmu

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统Id
`Status`	`U8`	只读	变更广播	状态
`PmuType`	`U8`	只读	变更广播	Pmu类型
`PmuVersion`	`String`	只读	变更广播	Pmu版本
`SFPMaxTemperature`	`U16`	只读	变更广播	光模块最大温度

方法

`Reset`

描述： 复位Imu

输出参数：

参数名	类型	描述
`Result`	`U8`	复位Imu结果

`GetPcieVidDid`

描述： 获取PCIe设备的制造商ID和设备ID

输入参数：

参数名	类型	描述
`SystemId`	`U8`	系统Id
`IsLocal`	`Boolean`	是否访问PCI本地空间
`CpuId`	`U8`	CPU索引号
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号

输出参数：

参数名	类型	描述
`VendorId`	`U16`	返回制造商ID
`DeviceId`	`U16`	返回设备ID

`GetPcieSubVidDid`

描述： 获取PCIe设备的子制造商ID和子设备ID

输入参数：

参数名	类型	描述
`SystemId`	`U8`	系统Id
`IsLocal`	`Boolean`	是否访问PCI本地空间
`CpuId`	`U8`	CPU索引号
`Bus`	`U8`	PCIe设备的总线号
`Device`	`U8`	PCIe设备的设备号
`Function`	`U8`	PCIe设备的功能号

输出参数：

参数名	类型	描述
`VendorId`	`U16`	返回制造商ID
`DeviceId`	`U16`	返回设备ID

bmc.kepler.Systems.PowerAction

属性

属性名	类型	可读写	信号通知	描述
`PowerOnTimeoutFlag`	`U8`	读写	变更广播	上电超时状态

bmc.kepler.Systems.PowerMgmt.OnePower

属性

属性名	类型	可读写	信号通知	描述
`SlotNumber`	`U32`	只读	变更广播	槽位号
`Manufacturer`	`String`	只读	变更广播	厂商
`Model`	`String`	只读	变更广播	电源型号
`PowerSupplyType`	`U32`	只读	变更广播	电源模块的供电类型，0:DC; 1:AC; 2: ACorDC; 3: Unknown
`Presence`	`U8`	只读	变更广播	在位状态
`PowerSupplyChannel`	`U8`	只读	变更广播	电源供电电路，0:主路 1:备路
`SerialNumber`	`String`	只读	变更广播	序列号
`PartNumber`	`String`	只读	变更广播	部件编码
`FirmwareVersion`	`String`	只读	变更广播	电源固件版本
`Protocol`	`String`	只读	变更广播
`DeviceLocator`	`String`	只读	变更广播	物理位置
`ProductionDate`	`String`	只读	变更广播	生产日期
`WorkMode`	`String`	只读	变更广播	单个电源主备工作模式（主用：Enabled，备用：StandbySpare）
`Position`	`String`	只读	变更广播	容器信息
`TotalRunningHours`	`U32`	只读	变更广播	总运行时间
`RedundancyGroupId`	`U8`	只读	变更广播	电源冗余组ID，非0值代表此电源冗余，0值代表电源不是冗余电源组的一员
`InputVoltageType`	`U8`	只读	变更广播	交直流模式 0:DC; 1:AC
`DMTFPowerSupplyType`	`U8`	只读	变更广播	DMTF电源类型: 1 Other;2 Unknown;3 Linear; 4 Switching; 5 Battery; 6 UPS; 7 Converter; 8 Regulator
`SourceType`	`U8`	只读	变更广播	功率读数来源，0：chip（功率传感器芯片，如INA220）; 1：PSU（电源MCU）
`IsPartOfSysPower`	`Boolean`	只读	变更广播	是否参与整机功耗计算,true:功耗纳入整机功耗计算,false:功耗不纳入整机功耗计算

方法

`SetPowerWorkMode`

描述： 设置电源工作模式

输入参数：

参数名	类型	描述
`PowerWorkMode`	`U8`	电源工作模式，1：设置为备用，0：设置为主用

输出参数：

参数名	类型	描述
`CmdResult`	`U8`	命令执行结果，0：设置成功，1：设置失败

bmc.kepler.Systems.PowerMgmt.OnePower.Metrics

属性

属性名	类型	可读写	信号通知	描述
`Rate`	`U16`	只读	变更广播	额定功率
`InputVoltage`	`Double`	只读	变更广播	输入电压
`OutputVoltage`	`Double`	只读	变更广播	输出电压
`InputCurrentAmps`	`Double`	只读	变更广播	输入电流
`OutputCurrentAmps`	`Double`	只读	变更广播	输出电流
`InputPowerWatts`	`Double`	只读	变更广播	单电源输入功率
`OutputPowerWatts`	`Double`	只读	变更广播	单电源输出功率
`RatedCurrentAmps`	`U16`	只读	变更广播	额定电流
`InputFrequencyHz`	`Double`	只读	变更广播	电源频率，交流显示频率直流显示为0

bmc.kepler.Systems.PowerMgmt.OnePower.Status

属性

属性名	类型	可读写	信号通知	描述
`Health`	`U8`	只读	变更广播	电源模块状态
`IsUpgrading`	`Boolean`	只读	变更广播	电源升级标识(false:未升级，true:升级中）
`OutputState`	`U8`	只读	变更广播	电源电压输出状态（0为异常）
`NormalAndRedundancySupported`	`Boolean`	只读	变更广播	是否支持N+R(true:支持，false:不支持)
`SleepMode`	`String`	只读	变更广播	电源休眠模式(Normal,DeepSleep)
`InputVoltageFault`	`U16`	只读	变更广播	电压输入状态（bit7:Vin_Ov_Fault, bit6:Vin_Ov_Warning, bit5:Vin_Uv_Warning, bit4:Vin_Uv_Fault），无效值32768，EVENT不处理
`OutputVoltageFault`	`U8`	只读	变更广播	电压输出状态（bit7:Vout_Ov_Fault, bit6:Vout_Ov_Warning, bit5:Vout_Uv_Warning, bit4:Vout_Uv_Fault）
`OutputCurrentFault`	`U8`	只读	变更广播	电流输出状态（bit7:Iout_Oc_Fault, bit5:Iout_Oc_Warning）
`FanFault`	`U8`	只读	变更广播	风扇状态（bit7:Fan1_Fault, bit5:Fan1_Warning, bit3:Fan1_Speed_Override）
`Fan1Fault`	`U8`	只读	变更广播	风扇1故障 0:无故障; 1:有故障(pmbus 只有一个风扇状态，pmbus8100 区分Fan1/2)
`Fan2Fault`	`U8`	只读	变更广播	风扇2故障 0:无故障; 1:有故障
`OverTemperature`	`U8`	只读	变更广播	过温故障 0:无故障; 1:有故障
`Failure`	`U8`	只读	变更广播	电源故障 0:无故障; 1:有故障
`LossOfInput`	`U8`	只读	变更广播	输入故障 0:无故障; 1:有故障
`DeepSleepEnabled`	`U8`	只读	变更广播	电源深度休眠使能(供告警使用) 0:未使能, 1:使能
`ScanStatus`	`U8`	只读	变更广播	电源信息采集任务执行情况（bit0：电源功率轮询，bit1：电源输入/输出电流/电压查询，bit2：电源模式查询）0表示该属性未获取过，1表示获取过
`InputVoltageStatus`	`U8`	只读	变更广播	输入电压过欠压、掉电状态，0x00：表示正常(默认)；0x01：表示过压；0x02：表示欠压；0x03：表示掉电；
`CommunicationStatus`	`U8`	只读	变更广播	电源通信状态，0：正常，1：故障

方法

`SetSleepMode`

描述： 设置电源休眠模式

输入参数：

参数名	类型	描述
`SleepMode`	`String`	电源休眠模式：Normal或DeepSleep

输出参数：

参数名	类型	描述
`CmdResult`	`U8`	命令执行结果，0：设置成功，1：设置失败

bmc.kepler.Systems.PowerMgmt.OnePower.Temperatures

属性

属性名	类型	可读写	信号通知	描述
`InletTemperatureCelsius`	`Double`	只读	变更广播	进风口温度
`InnerTemperatureCelsius`	`Double`	只读	变更广播	出风口温度
`EnvTemperatureCelsius`	`Double`	只读	变更广播	单个电源的环境温度
`PrimaryChipTemperatureCelsius`	`Double`	只读	变更广播	电源内部器件温度（原边）
`SecondaryChipTemperatureCelsius`	`Double`	只读	变更广播	电源内部器件温度（副边）

bmc.kepler.Systems.PowerOnLock

属性

属性名	类型	可读写	信号通知	描述
`PwrOnLocked`	`Boolean`	只读	变更广播	是否满足上电条件
`Reasons`	`String[]`	只读	变更广播	不允许上电的原因，KVM呈现，记录所有原因

方法

`SetPowerOnLock`

描述： 系统上电锁

输入参数：

参数名	类型	描述
`PwrOnLocked`	`Boolean`	是否上电锁定:true:锁定 false:解锁
`Timeout`	`U32`	有效的超时时间(单位1s)范围10~3600s
`AppName`	`String`	模块App名
`Reason`	`String`	增加上电锁的原因描述

输出参数：

参数名	类型	描述
`CmdResult`	`U8`	函数执行结果

bmc.kepler.Systems.PowerStrategy

属性

属性名	类型	可读写	信号通知	描述
`PowerWorkingMode`	`String`	只读	变更广播	电源工作模式
`PowerActualWorkingMode`	`String`	只读	变更广播	电源实际工作模式
`PowerLimitValue`	`U32`	只读	变更广播	功耗封顶值
`PowerLimitEnabled`	`Boolean`	只读	变更广播	功耗封顶使能
`ExpectedActivePSU`	`U8[]`	只读	变更广播	期望的主用电源列表
`MaxPowerLimitInWatts`	`U32`	只读	变更广播	功耗封顶上限值
`MinPowerLimitInWatts`	`U32`	只读	变更广播	功耗封顶下限值
`WorkModeConfigurable`	`Boolean`	只读	变更广播	是否支持电源工作模式
`PowerLimitFailed`	`Boolean`	只读	变更广播	功耗封顶是否失败
`PowerLimitActivated`	`Boolean`	只读	变更广播	功耗封顶策略是否触发
`PowerLimitExceptionSupported`	`Boolean`	只读	变更广播	是否支持功耗封顶失败动作
`PowerLimitExceptionLogEvent`	`Boolean`	读写	变更广播	是否支持功耗封顶失败动作记录事件日志
`PowerLimitException`	`String`	读写	变更广播	功耗封顶失败动作，包括不操作、重启且记录事件日志、下电且记录事件日志
`DeepSleep`	`String`	读写	变更广播	深度休眠使能
`PowerLimitWhenSteady`	`Boolean`	读写	变更广播	功耗封顶是否受限于BMC初始化完成
`NormalAndRedundancy`	`String`	只读	变更广播	N+R使能
`DeepSleepSupported`	`Boolean`	只读	变更广播	是否支持电源深度休眠功能
`NormalAndRedundancySupported`	`Boolean`	只读	变更广播	是否支持N+R备电功能
`ActiveStandbySupported`	`Boolean`	只读	变更广播	是否支持电源主备模式功能
`PowerCappingSupported`	`Boolean`	只读	变更广播	是否支持功耗封顶功能
`PowerPredictSupported`	`Boolean`	只读	变更广播	是否支持节能收益预测功能
`EnergyEfficiencyOptimizationSupported`	`Boolean`	只读	变更广播	是否支持智能能效寻优
`EnergySavingSupported`	`Boolean`	只读	变更广播	是否支持节能功能
`PSUsOutputVoltageLow`	`Boolean`	只读	变更广播	N+R压差是否异常
`RedundancyFailure`	`Boolean`	只读	变更广播	冗余失效
`PresetLimitInWatts`	`U32`	读写	变更广播	预设功率封顶值
`HighPowerThresholdWatts`	`Double`	只读	变更广播	功耗告警阈值
`PowerLimitMode`	`String`	只读	变更广播	功耗封顶模式
`PSUsUnavailableOfflineCause`	`U32`	只读	变更广播	电源不可用原因,bit0:电源输入丢失,京东定制电源线未插报电源冗余告警时使用
`PSUsOutputCurrentImbalance`	`Boolean`	只读	变更广播	电源均流不平衡

方法

`SetPowerWorkingMode`

描述： 设置电源工作模式

输入参数：

参数名	类型	描述
`PowerWorkingMode`	`String`	电源工作模式
`ActivePowerSuppliesList`	`U8[]`	主用电源列表

`SetPowerLimitValue`

描述： 设置功耗封顶值

输入参数：

参数名	类型	描述
`PowerLimitValue`	`U32`	功耗封顶值

`SetPowerLimitEnabled`

描述： 设置功耗封顶使能

输入参数：

参数名	类型	描述
`PowerLimitEnabled`	`Boolean`	功耗封顶使能

`SetNormalAndRedundancy`

描述： 设置N+R使能

输入参数：

参数名	类型	描述
`NormalAndRedundancy`	`String`	N+R使能

`UpdateGetPowerInfoTimeStamp`

描述： 更新最近一次iRM功耗管理请求时间

`SetPowerLimitMode`

描述： 设置功耗封顶模式

输入参数：

参数名	类型	描述
`PowerLimitMode`	`String`	功耗封顶模式

bmc.kepler.Systems.Processor

属性

属性名	类型	可读写	信号通知	描述
`ProcessorType`	`String`	只读	变更广播	处理器类型
`SystemId`	`U8`	只读	变更广播	系统Id
`Id`	`U8`	只读	变更广播	Id
`Name`	`String`	只读	变更广播	名字
`Presence`	`U8`	只读	变更广播	在位信息
`InstructionSet`	`String`	只读	变更广播	指令集
`Architecture`	`String`	只读	变更广播	芯片架构
`Manufacturer`	`String`	只读	变更广播	厂商
`Family`	`String`	只读	变更广播	处理器家族
`Model`	`String`	只读	变更广播	产品型号
`PartNumber`	`String`	只读	变更广播	部件号
`SN`	`String`	只读	变更广播	序列号
`FirmwareVersion`	`String`	只读	变更广播	固件版本
`SocketDesignation`	`String`	只读	变更广播	槽位
`Position`	`String`	只读	变更广播	容器：buc、pcie卡等
`ThermalTrip`	`U8`	读写	变更广播	CPU的过热保护状态
`Health`	`U8`	只读	变更广播	健康状态
`Replaceable`	`Boolean`	只读	变更广播	此部件是否可以作为独立的部件进行替换

bmc.kepler.Systems.Processor.CPU

属性

属性名	类型	可读写	信号通知	描述
`PhysicalId`	`U8`	只读	变更广播	物理ID
`LogicalId`	`U8`	只读	变更广播	逻辑ID
`MaxSpeedMHz`	`U32`	只读	变更广播	最大转速
`CurrentSpeedMHz`	`U32`	只读	变更广播	当前转速
`ProcessorID`	`U32`	只读	变更广播	cpu处理器id
`TotalCores`	`U32`	只读	变更广播	总核数
`TotalEnabledCores`	`U32`	只读	变更广播	可用核数
`TotalThreads`	`U32`	只读	变更广播	总线程
`L1Cache`	`U32`	只读	变更广播	一级缓存
`L2Cache`	`U32`	只读	变更广播	二级缓存
`L3Cache`	`U32`	只读	变更广播	三级缓存
`Characteristics`	`String`	只读	变更广播	特性
`TemperatureCelsius`	`Double`	读写	变更广播	温度（摄氏度）
`MaxMemoryTemperatureCelsius`	`Double`	读写	变更广播	最大温度
`MaxMemoryTemperatureName`	`String`	读写	变更广播	CPU下挂的最高温度内存标识
`DiagnosticFault`	`U8`	读写	变更广播	严重故障诊断告警状态
`PredictiveFault`	`U8`	读写	变更广播	预故障告警状态
`CATERR`	`U8`	只读	变更广播	宕机信号
`DeviceLocator`	`String`	只读	变更广播	处理器资源的丝印，以系统维度中的CPU个数。
`ProcessorHot`	`U8`	只读	变更广播	CPU的内核过热保护状态,确认是否通用
`Enabled`	`Boolean`	只读	变更广播	启用状态
`PowerGood`	`U8`	只读	变更广播	电源状态
`IsMemoryPresence`	`U8`	只读	变更广播	CPU下是否存在在位的内存，存在为1，否则为0
`PowerWatt`	`Double`	只读	变更广播	CPU功率
`TotalEnabledThreads`	`U32`	只读	变更广播	使能的超线程数
`SilkText`	`String`	只读	变更广播	处理器资源的板上丝印
`BaseSpeedMHz`	`U32`	只读	变更广播	处理器的基本（标称）时钟速度，以MHz为单位

bmc.kepler.Systems.Processor.GPU

属性

属性名	类型	可读写	信号通知	描述
`InfoRomVersion`	`String`	只读	变更广播	InfoRom版本
`Slot`	`String`	只读	变更广播	槽位号
`VendorID`	`U16`	只读	变更广播	厂商Id
`DeviceID`	`U16`	只读	变更广播	设备ID
`SubVendorID`	`U16`	只读	变更广播	子系统厂商Id
`SubDeviceID`	`U16`	只读	变更广播	子系统设备Id
`GPUUtilization`	`U16`	只读	变更广播	GPU 利用率（%）
`MemoryUtilization`	`U16`	只读	变更广播	GPU 内存利用率（%）
`BoardPartNumber`	`String`	只读	变更广播	单板部件号
`MemoryVendor`	`String`	只读	变更广播	内存厂商
`MemoryPartNumber`	`String`	只读	变更广播	内存部件号
`BuildDate`	`String`	只读	变更广播	构建时间
`UUID`	`String`	只读	变更广播	通用唯一标识符

bmc.kepler.Systems.Processor.GPU.Power

属性

属性名	类型	可读写	信号通知	描述
`PowerWatts`	`U16`	只读	变更广播	功率
`PowerBrakeSet`	`U8`	只读	变更广播	power brake状态
`ExternalPowerSufficient`	`U8`	只读	变更广播	外部供电是否充足

bmc.kepler.Systems.Processor.GPU.Status

属性

属性名	类型	可读写	信号通知	描述
`ECCModeEnabled`	`U8`	只读	变更广播	ECC模式当前使能状态
`ECCModePendingEnabled`	`U8`	只读	变更广播	ECC模式重启后使能状态
`ResetRequired`	`U8`	只读	变更广播	是否需要重启
`DoubleBitErrorPageCount`	`U32`	只读	变更广播	双bit失效故障页个数
`SingleBitErrorPageCount`	`U32`	只读	变更广播	单bit失效故障页个数
`NvLinkInfo`	`Array`	只读	变更广播	连接状态、Replay错误计数、Recovery错误计数、流控CRC错误计数、数据CRC错误计数

自定义类型

NvLinkInfoItem 结构：

字段名	类型	描述
LinkStatus	String	连接状态
ReplayErrorCount	U32	Replay错误计数
RecoveryErrorCount	U32	Recovery错误计数
FlowControlCRCErrorCount	U32	流控CRC错误计数
DataCRCErrorCount	U32	数据CRC错误计数

bmc.kepler.Systems.Processor.NPU

属性

属性名	类型	可读写	信号通知	描述
`TotalMemoryKiB`	`U32`	只读	变更广播	片上内存-总内存大小
`MemoryUsageKiB`	`U32`	只读	变更广播	片上内存-内存已用大小
`MemoryFreeKiB`	`U32`	只读	变更广播	片上内存-内存剩余大小
`CapabilitySupportMask`	`U32`	只读	变更广播	能力支持掩码
`MemoryCapacityKiB`	`U32`	只读	变更广播	板卡NPU芯片-内存容量
`MultiBitEcc`	`String`	只读	变更广播	多bit ECC信息
`SingleBitEcc`	`String`	只读	变更广播	单bit ECC信息
`AiCPUUsagePercent`	`U16`	只读	变更广播	AiCpu使用率（%）
`HBMBWUsagePercent`	`U16`	只读	变更广播	HBM带宽使用率（%）
`MemBWUsagePercent`	`U16`	只读	变更广播	内存带宽使用率（%）
`HBMUsagePercent`	`U16`	只读	变更广播	HBM容量使用率（%）
`MemUsagePercent`	`U16`	只读	变更广播	内存容量使用率（%）
`AiCoreUsagePercent`	`U16`	只读	变更广播	核心网使用百分比
`AiCoreMaxSpeedMHz`	`U16`	只读	变更广播	Ai Core占用率（%）
`AiCoreCurrentSpeedMHz`	`U16`	只读	变更广播	Ai Core当前主频，单位：MHz
`CtrlCPUUsagePercent`	`U16`	只读	变更广播	ctrl CPU 占用率
`ComputeCapability`	`String`	只读	变更广播	芯片算力规格
`NimBusTemp`	`U16`	只读	变更广播	芯片外围设备NimBus温度
`AiCoreTemp`	`U16`	只读	变更广播	AiCore计算核心温度
`HBMTemp`	`U16`	只读	变更广播	HBM内存温度
`PowerOn`	`U8`	只读	变更广播	开机
`PowerState`	`String`	只读	变更广播	NPU芯片上下电状态, 当前取值: Off、PoweringOff、On、PoweringOn
`PowerCapacityWatts`	`U32`	只读	变更广播	板卡NPU芯片-额定功耗
`PowerConsumedWatts`	`U16`	只读	变更广播	板卡NPU芯片-实际功耗
`Volt`	`U32`	只读	变更广播	npu电压，单位nV
`Power`	`U16`	只读	变更广播	功耗，单位W
`VRDChipTemp`	`U16`	只读	变更广播	VRD chip温度
`BDF`	`String`	只读	变更广播	BDF编号
`RootBDF`	`String`	只读	变更广播	芯片BDF
`MemoryBandWidth`	`U32`	只读	变更广播	板卡NPU芯片-额定带宽
`ReadingCelsius`	`U16`	只读	变更广播	板卡NPU芯片-实际温度
`Ierr`	`U8`	只读	变更广播	NPU宕机异常汇聚信号 0：正常 1：异常
`PredictiveFault`	`U8`	读写	变更广播	预故障告警状态
`DiagnosticFault`	`U8`	读写	变更广播	严重故障诊断告警状态
`ECCAlarmStatus`	`U8`	只读	变更广播	NPU ECC错误告警状态 2-严重告警(NPU ECC历史计数超门限值64) 1-事件 (NPU ECC历史计数超门限值32) 0-NPU ECC历史计数超门限值的情况未发生
`IErrFlag`	`U32`	只读	变更广播	NPU宕机异常汇聚信号 0：正常 1：异常
`VendorID`	`U16`	只读	变更广播	槽位号
`Version`	`String`	只读	变更广播	版本
`DriverVersion`	`String`	只读	变更广播	驱动版本
`FaultCode`	`String`	只读	变更广播	NPU带内故障码
`PowerCapWatts`	`U16`	只读	变更广播	NPU模组功耗封顶值，单位W
`TotalCores`	`U32`	只读	变更广播	NPU核数
`Location`	`String`	只读	变更广播	NPU所属抽屉信息
`FlashIds`	`U64[]`	只读	变更广播	NPU的flashid列表
`Slot`	`U8`	只读	变更广播	NPU的物理槽位信息

方法

`GetEccInfo`

描述： 获取NPU HBM Ecc信息

输入参数：

参数名	类型	描述
`Id`	`U8`	NPU编号，和硬件丝印匹配

输出参数：

参数名	类型	描述
`SingleBitEcc`	`String`	单bit Ecc信息, Json字符串格式
`MultiBitEcc`	`String`	多bit Ecc信息, Json字符串格式
`SingleBitIsolatedPages`	`String`	单bit 隔离页信息, Json字符串格式
`MultiBitIsolatedPages`	`String`	多bit 隔离页信息, Json字符串格式

bmc.kepler.Systems.Processor.NPUs

方法

`DumpNpuLog`

描述： 收集NPU日志

输入参数：

参数名	类型	描述
`NpuId`	`U8`	NPU芯片编号

输出参数：

参数名	类型	描述
`TaskId`	`U32`	收集日志的任务ID

bmc.kepler.Systems.Processor.ProcessorMetrics

属性

属性名	类型	可读写	信号通知	描述
`BandwidthPercent`	`U8`	只读	变更广播	占用率
`BandwidthThresholdPercent`	`U8`	只读	变更广播	占用率门限
`ConsumedPowerWatt`	`U32`	只读	变更广播	功耗

方法

`SetBandwidthThreshold`

描述： 设置Cpu占用率门限

输入参数：

参数名	类型	描述
`BandwidthThresholdPercent`	`U8`	Cpu占用率门限

输出参数：

参数名	类型	描述
`Result`	`S32`	设置Cpu占用率门限结果

`GetBandwidthHistory`

描述： 获取Cpu占用率的历史数据

输出参数：

参数名	类型	描述
`History`	`String`	Cpu占用率的历史数据

`ClearBandwidthHistory`

描述： 清除Cpu占用率的历史数据

bmc.kepler.Systems.Product

属性

属性名	类型	可读写	信号通知	描述
`ProductName`	`String`	只读	变更广播	产品名称
`ProductAlias`	`String`	读写	变更广播	产品别名
`ProductPicture`	`String`	只读	变更广播	产品web界面展示图片名称
`ProductVendorID`	`String`	只读	变更广播	产品厂商ID
`ProductId`	`U32`	只读	变更广播	产品ID
`ProductUniqueID`	`String`	只读	变更广播	产品唯一识别ID
`ProductVersion`	`String`	读写	变更广播	产品版本
`LanguageSet`	`String[]`	读写	变更广播	当前开启的语言集

方法

`RetireSystem`

描述： 产品报废处置

输入参数：

参数名	类型	描述
`PreserveLog`	`Boolean`	是否保存报警、维护和故障诊断日志

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务标识

`GetRetirementStatus`

描述： 获取报废处置任务状态信息

输出参数：

参数名	类型	描述
`Status`	`String`	整体任务状态
`Progress`	`U8`	整体任务进度
`Details`	`TaskStateDict`	子任务状态信息

自定义类型

TaskStateDict 结构：

字段名	类型	描述
key	String	子任务名称
value	String	子任务状态

bmc.kepler.Systems.Product.Custom

属性

属性名	类型	可读写	信号通知	描述
`OemData`	`U8[]`	读写	变更广播	第三方共享信息,对外提供设置和查询接口
`Manufacturer`	`String`	读写	变更广播	定制化厂商名称, redfish接口OEM厂商字段, 默认为Huawei, 中移动定制修改为Public
`SmsName`	`String`	读写	变更广播	带内管理软件名称, 默认iBMA
`ManufacturerOid`	`String`	读写	变更广播	定制化厂商Oid, snmp接口Oid厂商字段, 默认为2011.2.235.1.1

bmc.kepler.Systems.Product.Device

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	设备名称
`SerialNumber`	`String`	只读	变更广播	设备序列号
`OwnerId`	`String`	只读	变更广播	设备所有者ID

bmc.kepler.Systems.Product.DigitalWarranty

属性

属性名	类型	可读写	信号通知	描述
`StartPoint`	`String`	读写	变更广播	服务起始时间, 用户可配置, 默认生产日期生成的服务起始时间为1996-04-10
`Lifespan`	`U8`	读写	变更广播	服务年限，用户可配置
`FirstPowerOnTime`	`String`	只读	变更广播	服务器首次上电时间, 根据生产日期生成, 格式为: YYYY-MM-DD

bmc.kepler.Systems.Pump

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U16`	只读	变更广播	泵ID
`Slot`	`U8`	只读	变更广播	槽位
`Model`	`String`	只读	变更广播	型号
`PartNumber`	`String`	只读	变更广播	部件号
`ExpectedPWM`	`Double`	只读	变更广播	预期的PWM值
`ActualPWM`	`Double`	只读	变更广播	实际PWM值
`MaxSupportedPWM`	`U32`	只读	变更广播	泵全速额定PWM值
`SpeedRPM`	`U16`	只读	变更广播	泵转速(转/分钟）
`MaxSpeedRPM`	`U32`	只读	变更广播	泵全速额定转速(转/分钟）
`Presence`	`U8`	只读	变更广播	1在位，0不在位
`Status`	`U8`	只读	变更广播	泵状态，0：正常，1：转速异常，2：在位异常，3：停转

bmc.kepler.Systems.Pumps

属性

属性名	类型	可读写	信号通知	描述
`WorkInStandby`	`U8`	只读	变更广播	standby下是否可以运转

方法

`SetPWM`

描述： 设置所有泵转速

输入参数：

参数名	类型	描述
`PWM`	`Double[]`	要设置的转速占空比数组

输出参数：

参数名	类型	描述
`Result`	`U8`	返回结果，0：设置成功；1：设置失败

bmc.kepler.Systems.Retimer

属性

属性名	类型	可读写	信号通知	描述
`ChipName`	`String`	只读	变更广播	芯片名称
`ChipType`	`U8`	只读	变更广播	芯片类型：0为5902L、1为5902H、2为5901、3为ds280
`FirmwareVersion`	`String`	只读	变更广播	retimer版本号
`ChipLocation`	`String`	只读	变更广播	芯片位置号(丝印)
`TemperatureCelsius`	`S16`	只读	变更广播	retimer的温度
`DieID`	`String`	只读	变更广播	芯片 DIEID
`HealthStatus`	`U8`	只读	变更广播	芯片健康状态：0为正常，1为异常

bmc.kepler.Systems.SecureBootOptions

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统Id
`CertificateExpired`	`U8`	只读	变更广播	证书过期标记

方法

`ImportCertificate`

描述： 导入Bios的安全启动证书

输入参数：

参数名	类型	描述
`DatabseType`	`String`	数据库类型 db、dbx
`CertString`	`String`	Bios的安全启动证书内容
`CertType`	`String`	Bios的安全启动证书类型

`ResetCertificate`

描述： 重置Bios安全启动证书

输入参数：

参数名	类型	描述
`DatabseType`	`String`	数据库类型 db、dbx
`ResetType`	`String`	重置Bios安全启动证书类型

`GetCertificate`

描述： 获取Bios安全启动证书

输出参数：

参数名	类型	描述
`CertInfo`	`String`	Bios安全启动证书内容

bmc.kepler.Systems.SecurityModule

属性

属性名	类型	可读写	信号通知	描述
`Presence`	`U8`	只读	变更广播	在位情况
`Health`	`U8`	只读	变更广播	健康状态
`Protocol`	`String`	只读	变更广播	协议类型
`Manufacturer`	`String`	只读	变更广播	厂商名称
`ProtocolVersion`	`String`	只读	变更广播	协议版本
`FirmwareVersion`	`String`	只读	变更广播	固件版本

bmc.kepler.Systems.SmBios

属性

属性名	类型	可读写	信号通知	描述
`SerialNumber`	`String`	只读	变更广播	SmBios序列号
`Version`	`String`	只读	变更广播	SmBios版本
`SKUNumber`	`String`	只读	变更广播	SmBios SKU编号
`Family`	`String`	只读	变更广播	处理器家族
`SmBiosStatus`	`U8`	只读	变更广播	SmBios状态
`SmBiosUpdatedFlag`	`U8`	只读	变更广播	SmBios状态更新标记
`FileChange`	`U8`	只读	变更广播	SmBios文件变化标记
`FileName`	`String`	只读	变更广播	SmBios文件名
`DiffFileName`	`String`	只读	变更广播	SmBios差异文件名
`SystemId`	`U8`	只读	变更广播	系统Id

bmc.kepler.Systems.SmartProvision

属性

属性名	类型	可读写	信号通知	描述
`MajorVersion`	`String`	只读	变更广播	SmartProvision主版本号
`MinorVersion`	`String`	只读	变更广播	SmartProvision次版本号
`LogicalDriveStateAbnormal`	`U8`	只读	变更广播	系统中逻辑盘的状态，存在异常状态的逻辑盘时为1，不存在时为0

bmc.kepler.Systems.Sms

属性

属性名	类型	可读写	信号通知	描述
`ChannelType`	`U8`	只读	变更广播	通道类型，0：虚拟网卡 1：字符设备 2：USB
`Id`	`U8`	只读	变更广播	系统ID
`Registered`	`Boolean`	只读	变更广播	注册状态
`Name`	`String`	只读	变更广播	带内代理注册的名字
`Version`	`String`	只读	变更广播	带内代理的版本号
`Type`	`String`	只读	变更广播	带内代理注册的类型
`IsSupported`	`Boolean`	只读	变更广播	带内代理使能状态，主要用于前端显示
`WhiteList`	`String`	只读	变更广播	带内代理设置的白名单，决定了那些接口可以透传
`DriverVersion`	`String`	只读	变更广播	带内代理驱动版本号，主要用于前端显示
`CdevChannelEnabled`	`Boolean`	只读	变更广播	字符设备通道打开关闭,默认ture

方法

`SetForwardWhiteList`

描述： 设置BMC直接访问BMA资源的白名单

输入参数：

参数名	类型	描述
`Request`	`String`	白名单列表

输出参数：

参数名	类型	描述
`Response`	`String`	函数调用结果

`ForwardRequest`

描述： BMC请求BMA资源透传转发接口

输入参数：

参数名	类型	描述
`Request`	`String`	请求参数,如url等
`RetryTimes`	`U8`	请求重试次数

输出参数：

参数名	类型	描述
`Response`	`String`	函数调用结果

`ForwardEvent`

描述： BMC订阅BMA资源变更事件后,事件上报接口

输入参数：

参数名	类型	描述
`RequestMethod`	`String`	请求方法, GET、POST等
`RequestToken`	`String`	带内token
`RequestBody`	`String`	BMA传入的请求体

输出参数：

参数名	类型	描述
`ResponseStatusCode`	`U32`	HTTP请求返回码

`UpdateSpecificResource`

描述： 更新指定类型的资源

输入参数：

参数名	类型	描述
`ResourceType`	`String`	资源类型

输出参数：

参数名	类型	描述
`Response`	`String`	资源更新处理结果

`SetChannelType`

描述： 设置BOB通道类型,以及是否需要持久化

输入参数：

参数名	类型	描述
`ChannelType`	`U8`	通道类型, 0:虚拟网卡 1:字符设备 2:USB
`IsPowerOffPer`	`Boolean`	是否持久化

`GetChannelType`

描述： 获取BOB channel类型

输入参数：

参数名	类型	描述
`IsPowerOffPer`	`Boolean`	是否获取持久化属性

输出参数：

参数名	类型	描述
`ChannelType`	`U8`	通道类型

`SetCdevChannelEnabled`

描述： 带外设置cdev通道使能

输入参数：

参数名	类型	描述
`Enabled`	`Boolean`	是否使能

bmc.kepler.Systems.Sms.AgentPort

属性

属性名	类型	可读写	信号通知	描述
`LocalPort`	`U16`	只读	变更广播	BMC作为客户端，且通道不为Veth时，net_nat服务监听的本地回环口的端口
`ServerPort`	`U16`	只读	变更广播	BMC作为客户端时，BMA作为服务端的端口号
`ServiceType`	`String`	只读	变更广播	服务类型可选参数，可选：Snmp,Https

bmc.kepler.Systems.Sms.AgentPorts

属性

属性名	类型	可读写	信号通知	描述
`ServerMaxPort`	`U16`	读写	变更广播	BMC作为客户端，通道为VETH时，BMA为服务端的最大端口号
`ServerMinPort`	`U16`	读写	变更广播	BMC作为客户端，通道为VETH时，BMA为服务端的最大端口号

bmc.kepler.Systems.Sms.SmsStatus

属性

属性名	类型	可读写	信号通知	描述
`RunningState`	`String`	只读	变更广播	Sms运行状态，用于前端页面展示
`UpdateState`	`U8`	只读	变更广播	Sms资源更新状态，0：no start 1:update complete 2：update default
`State`	`U8`	只读	变更广播	带内代理状态，0：正常 1：异常
`HeartBeatState`	`U8`	只读	变更广播	心跳状态，0：正常 1：异常

bmc.kepler.Systems.Sms.Veth

属性

属性名	类型	可读写	信号通知	描述
`Port`	`U32`	只读	变更广播	带内代理支持的虚拟网口端口
`IpAddr`	`String`	只读	变更广播	带内代理支持的虚拟网口的IP端口
`ProtocolType`	`U8`	只读	变更广播	带内协议类型, 0表示HTTP, 1表示HTTPS, 默认是 HTTPS 协议

bmc.kepler.Systems.Storage.Battery

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	BBU名称
`State`	`U8`	只读	变更广播	BBU在位信息
`Fault`	`U8`	只读	变更广播	BBU故障标志
`HealthStatus`	`U32`	只读	变更广播	bit0:电压过低,bit1:需要更换BBU,bit2:电量校准失败,bit3:电量校准超时,bit4:预故障,bit5:剩余容量低,bit6:没有用于缓存卸载的空间,others:resrved
`Health`	`U8`	只读	变更广播	BBU健康状态
`TemperatureCelsius`	`S16`	只读	变更广播	BBU温度

bmc.kepler.Systems.Storage.Controller

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U8`	只读	变更广播	控制器Id, 由软件生成，默认值0xFF
`Type`	`String`	只读	变更广播	控制器类型
`Name`	`String`	只读	变更广播	控制器名称
`TemperatureCelsius`	`S16`	只读	变更广播	控制器芯片温度
`TemperatureAbnormal`	`U8`	只读	变更广播	温度异常描述，温度获取失败时置1
`OOBSupport`	`U8`	只读	变更广播	支持带外管理模式，0：不支持带外；1：支持带外
`FirmwareVersion`	`String`	只读	变更广播	控制器固件版本
`SupportedMode`	`String[]`	只读	变更广播	控制器工作模式
`MemorySizeMiB`	`U16`	只读	变更广播	控制器内存大小，单位MB
`DeviceInterface`	`String`	只读	变更广播	控制器设备接口
`SASAddr`	`String`	只读	变更广播	控制器SAS地址
`SerialNumber`	`String`	只读	变更广播	控制器序列号
`MaxStripSizeBytes`	`U32`	只读	变更广播	控制器支持的最大条带
`MinStripSizeBytes`	`U32`	只读	变更广播	控制器支持的最小条带
`NVDataVersion`	`String`	只读	变更广播	控制器配置版本
`MaintainPDFailHistrory`	`U8`	只读	变更广播	是否启用控制器的物理盘故障记忆功能
`PCIeLinkWidth`	`String`	只读	变更广播	控制器的PCIE带宽
`UnconfiguredDriveWriteCachePolicy`	`String`	只读	变更广播	非RAID组成员盘的写缓存策略:Enabled,Disabled,Default
`HBADriveWriteCachePolicy`	`String`	只读	变更广播	HBA模式下硬盘的写缓存策略:Enabled,Disabled,Default
`ConfiguredDriveWriteCachePolicy`	`String`	只读	变更广播	RAID组成员盘的写缓存策略:Enabled,Disabled,Default
`SupportedRAIDTypes`	`String[]`	只读	变更广播	RAID级别
`SmarterCopyBackState`	`U8`	只读	变更广播	RAID控制器在检测到物理盘SMART错误之后是否自动进行Copyback
`CopyBackState`	`U8`	只读	变更广播	指定控制器的回拷功能使能状态
`BootDevices`	`String[]`	只读	变更广播	控制器的启动设备列表
`HardwareRevision`	`String`	只读	变更广播	控制器的硬件版本
`HotSpareActivationMode`	`String`	只读	变更广播	控制器的热备激活模式:Failure,Predictive,Unknown
`NoBatteryWriteCacheEnabled`	`U8`	只读	变更广播	控制器的无电池写缓存模式
`ReadCachePercent`	`U8`	只读	变更广播	控制器的读缓存百分比，取值范围：0~100
`JBODState`	`U8`	只读	变更广播	控制器的JBOD功能状态：false，true
`CachePinnedState`	`U8`	只读	变更广播	控制器的Cache Pinned开关
`DDREccCount`	`U16`	只读	变更广播	DDR ECC计数
`WorkMode`	`String`	只读	变更广播	控制器的工作模式, 包括RAID、HBA、JBOD和MIXED四种
`RefDrives`	`String[]`	只读	变更广播	控制器下挂载的所有硬盘名
`CryptoEraseSupported`	`Boolean`	只读	变更广播	驱动器是否支持加密盘数据擦除
`TypeId`	`U8`	只读	变更广播	控制器的类型Id
`DeviceName`	`String`	只读	变更广播	对应的PCIeDevice的设备名
`BOMNumber`	`String`	只读	变更广播	BOM编码
`Position`	`String`	只读	变更广播	对应的PCIeDevice的位置

方法

`SetBootDevices`

描述： 设置控制器的启动盘设备

输入参数：

参数名	类型	描述
`PriorityDriveName`	`String`	设备1名称
`SecondaryDriveName`	`String`	设备2名称

`SetJBODState`

描述： 设置控制器的JBOD功能状态

输入参数：

参数名	类型	描述
`State`	`U8`	状态 0:Disable 1:Enable

`SetSmarterCopyBackState`

描述： 设置RAID控制器在检测到物理盘SMART错误之后是否自动进行Copyback

输入参数：

参数名	类型	描述
`State`	`U8`	状态 0:Disable 1:Enable

`RestoreDefaultSettings`

描述： 恢复控制器的默认配置

`SetCopybackState`

描述： 设置控制器的回拷功能

输入参数：

参数名	类型	描述
`State`	`U8`	状态 0:Disable 1:Enable

`SetWorkMode`

描述： 设置控制器的工作模式

输入参数：

参数名	类型	描述
`Mode`	`U8`	工作模式: Mode的取值为0:RAID, 1:HBA, 2:RAID, 3:MIXED
`ProfileId`	`U8`	配置文件的IP, 取值为0

`ImportForeignConfig`

描述： 一键导入外部配置

`DumpLog`

描述： 收集RAID控制器信息

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`ClearForeignConfig`

描述： 一键清除外部配置

`SetNoBatteryWriteCache`

描述： 设置控制器无电池写缓存状态

输入参数：

参数名	类型	描述
`NoBatteryWriteCacheEnabled`	`U8`	0-Disable, 1-Enable

`SetReadCachePercent`

描述： 设置控制器读缓存百分比

输入参数：

参数名	类型	描述
`ReadCachePercent`	`U8`	取值范围：0~100

`SetWriteCachePolicy`

描述： 设置控制器写缓存策略

输入参数：

参数名	类型	描述
`Type`	`String`	RAID卡下的硬盘管理类型
`WriteCachePolicy`	`String`	写缓存策略

bmc.kepler.Systems.Storage.Controller.BatteryStatus

属性

属性名	类型	可读写	信号通知	描述
`BatteryPresence`	`U8`	只读	变更广播	控制器下挂载的电池在位信息
`BatteryFault`	`U8`	只读	变更广播	控制器下挂载的电池故障信息
`BatteryHealth`	`U8`	只读	变更广播	控制器下挂载的电池健康信息

bmc.kepler.Systems.Storage.Controller.Chip

属性

属性名	类型	可读写	信号通知	描述
`Model`	`String`	只读	变更广播	raid卡芯片型号
`ChipManufacturer`	`String`	只读	变更广播	raid卡芯片厂商

bmc.kepler.Systems.Storage.Controller.ConsistencyCheck

属性

属性名	类型	可读写	信号通知	描述
`State`	`U8`	只读	变更广播	RAID控制器一致性校验功能状态
`PeriodOfHours`	`U16`	只读	变更广播	RAID控制器一致性校验周期，单位(小时), 取值范围[1:1440]
`Rate`	`String`	只读	变更广播	RAID控制器一致性校验速率
`AutoRepairEnabled`	`U8`	只读	变更广播	RAID控制器一致性校验自修复开关
`RunningStatus`	`String`	只读	变更广播	RAID控制器一致性校验状态
`TotalVolumeCounts`	`U16`	只读	变更广播	RAID控制器一致性校验需要校验的总数量
`CompletedVolumeCounts`	`U16`	只读	变更广播	RAID控制器一致性校验运行已经完成的数量
`DelayToStart`	`U32`	只读	变更广播	RAID控制器一致性校验任务的等待开始时间，取值范围[0:24]，时间单位：h

方法

`Enable`

描述： 打开控制器的一致性校验功能

输入参数：

参数名	类型	描述
`Period`	`U16`	RAID控制器一致性校验周期，单位(小时), 取值范围[1:1440]
`Rate`	`U8`	RAID控制器一致性校验速率
`AutoRepairedEnabled`	`U8`	自动修复启用使能
`DelayToStart`	`U32`	RAID控制器一致性校验任务的等待开始时间，取值范围[0:24]，时间单位：h

`Disable`

描述： 关闭控制器的一致性校验功能

`SetParameters`

描述： 设置控制器的一致性校验信息

输入参数：

参数名	类型	描述
`Period`	`U16`	RAID控制器一致性校验周期，单位(小时), 取值范围[1:1440]
`Rate`	`U8`	RAID控制器一致性校验速率
`AutoRepairedEnabled`	`U8`	自动修复启用使能

bmc.kepler.Systems.Storage.Controller.ControllerStatus

属性

属性名	类型	可读写	信号通知	描述
`FaultCode`	`U16`	只读	变更广播	控制器的故障码
`CommunicationLoss`	`U8`	只读	变更广播	控制器通信丢失标志
`Health`	`U8`	只读	变更广播	控制器健康状态
`FaultCodeByBios`	`U8`	只读	变更广播	BIOS上报的硬件故障错误码。0：正常；非0：故障

bmc.kepler.Systems.Storage.Controller.Driver

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	控制器驱动器名称
`Version`	`String`	只读	变更广播	控制器驱动器版本

bmc.kepler.Systems.Storage.Controller.VolumeManage

属性

属性名	类型	可读写	信号通知	描述
`CreateVolumeSupported`	`Boolean`	只读	变更广播	控制器是否支持创建逻辑盘
`SupportedReadPolicyList`	`String[]`	只读	变更广播	支持的逻辑盘读策略列表
`DefaultReadPolicy`	`String`	只读	变更广播	默认的逻辑盘读策略
`ReadPolicyWritable`	`Boolean`	只读	变更广播	支持修改逻辑盘读策略
`SupportedWritePolicyList`	`String[]`	只读	变更广播	支持的逻辑盘写策略列表
`DefaultWritePolicy`	`String`	只读	变更广播	默认的逻辑盘写策略
`WritePolicyWritable`	`Boolean`	只读	变更广播	支持修改逻辑盘写策略
`SupportedIOPolicyList`	`String[]`	只读	变更广播	支持的逻辑盘IO策略列表
`DefaultIOPolicy`	`String`	只读	变更广播	默认的逻辑盘IO策略
`IOPolicyWritable`	`Boolean`	只读	变更广播	支持修改逻辑盘IO策略
`SupportedAccessPolicyList`	`String[]`	只读	变更广播	支持的逻辑盘访问策略列表
`DefaultAccessPolicy`	`String`	只读	变更广播	默认的逻辑盘访问策略
`AccessPolicyWritable`	`Boolean`	只读	变更广播	支持修改逻辑盘访问策略
`SupportedDriveCachePolicyList`	`String[]`	只读	变更广播	支持的逻辑盘硬盘缓存策略列表
`DefaultDriveCachePolicy`	`String`	只读	变更广播	默认的逻辑盘硬盘缓存策略
`DriveCachePolicyWritable`	`Boolean`	只读	变更广播	支持修改逻辑盘硬盘缓存策略

方法

`CreateVolumeInNewArray`

描述： 用全新阵列创建逻辑盘

输入参数：

参数名	类型	描述
`DriveLists`	`U8[]`	设备列表
`RaidType`	`U8`	raid卡类型
`SpanDepth`	`U8`	阵列的数量
`Name`	`String`	创建逻辑盘的名称
`Capacity`	`U32`	容量
`CapacityUnit`	`U8`	容量单位
`StripSize`	`U8`	条带大小
`ReadPolicy`	`U8`	逻辑盘读策略
`WritePolicy`	`U8`	逻辑盘写策略
`IOPolicy`	`U8`	逻辑盘IO策略
`AccessPolicy`	`U8`	逻辑盘访问策略
`DiskCachePolicy`	`U8`	硬盘Cache策略
`InitType`	`U8`	初始化类型
`Accelerator`	`U8`	加速方法

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`DeleteVolume`

描述： 删除指定逻辑盘

输入参数：

参数名	类型	描述
`VolumeId`	`U16`	存储卷ID

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`CreateVolumeInExisingtArray`

描述： 在已有阵列上创建逻辑盘

输入参数：

参数名	类型	描述
`ArrayId`	`U16`	阵列ID
`BlockIndex`	`U8`	块索引
`RaidType`	`U8`	raid卡类型
`SpanDepth`	`U8`	阵列的数量
`Name`	`String`	创建逻辑盘的名称
`Capacity`	`U32`	容量
`CapacityUnit`	`U8`	容量单位
`StripSize`	`U8`	条带大小
`ReadPolicy`	`U8`	逻辑盘读策略
`WritePolicy`	`U8`	逻辑盘写策略
`IOPolicy`	`U8`	逻辑盘IO策略
`AccessPolicy`	`U8`	逻辑盘访问策略
`DiskCachePolicy`	`U8`	硬盘Cache策略
`InitType`	`U8`	初始化类型
`Accelerator`	`U8`	加速方法

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`CreateCachecadeVolume`

描述： 创建cachecade逻辑盘

输入参数：

参数名	类型	描述
`DriveLists`	`U8[]`	设备列表
`RaidType`	`U8`	raid卡类型
`Name`	`String`	创建逻辑盘的名称
`WritePolicy`	`U8`	逻辑盘写策略
`ArrayId`	`U16`	阵列ID
`Capacity`	`U32`	容量
`CapacityUnit`	`U8`	容量单位
`AssociateLd`	`U16`	关联逻辑盘
`CacheLineSize`	`U8`	缓存行大小

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

bmc.kepler.Systems.Storage.Diagnose

属性

属性名	类型	可读写	信号通知	描述
`PhyErrorEnabled`	`Boolean`	读写	变更广播	PHY误码诊断使能
`PhyErrorInterval`	`U32`	读写	变更广播	PHY误码数据采集的时间间隔，单位秒
`PhyErrorMaxRecord`	`U8`	读写	变更广播	PHY误码在一个OS启动周期内记录的最大条数（有增长的记录）
`PhyErrorThreshold`	`U32`	读写	变更广播	PHY误码单位时间增长过快的判断门限值
`MaxPhyErrorLogFileRotationCount`	`U8`	读写	变更广播	PHY误码循环记录的最大文件数
`PhyErrorSelUnlimitFlag`	`Boolean`	读写	变更广播	PHY误码是否允许产生多个SEL告警事件

bmc.kepler.Systems.Storage.DiskArray

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U16`	只读	变更广播	RAID组的序号，由RAID卡读到
`UsedSpaceMiB`	`U32`	只读	变更广播	RAID组的已使用的空间
`TotalFreeSpaceMiB`	`U32`	只读	变更广播	RAID组的空闲空间
`FreeBlocksSpaceMiB`	`U32[]`	只读	变更广播	RAID组的空闲块容量列表
`RefVolumes`	`U16[]`	只读	变更广播	RAID组的关联逻辑盘列表，例：[145, 144]
`RefDrives`	`String[]`	只读	变更广播	RAID组的关联物理盘列表，例：[Disk0, Disk1]
`AverageDriveFreeSpaceMiB`	`U32`	只读	变更广播	指定驱动器阵列中每个驱动器的剩余容量
`DriveNumPerSpan`	`U8`	只读	变更广播	驱动器阵列中每个Span的成员的个数
`RAIDType`	`String`	只读	变更广播	驱动器阵列组成的虚拟磁盘的级别
`RefControllerId`	`U8`	只读	变更广播	RAID组关联的控制器ID

bmc.kepler.Systems.Storage.DiskPartition

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	只读	变更广播	os盘符
`Usage`	`U8`	只读	变更广播	磁盘分区利用率
`TotalCapacityGiB`	`Double`	只读	变更广播	硬盘分区总容量
`UsedCapacityGiB`	`Double`	只读	变更广播	硬盘分区当前使用容量

bmc.kepler.Systems.Storage.Drive

属性

属性名	类型	可读写	信号通知	描述
`NodeId`	`String`	只读	变更广播	资源的唯一Id
`Id`	`U8`	只读	变更广播	硬盘Id, 由软件生成，默认值0
`SlotNumber`	`U8`	只读	变更广播	硬盘槽位号
`Name`	`String`	只读	变更广播	硬盘名称，Disk1，NMVeDisk1等
`Presence`	`U8`	只读	变更广播	硬盘在位状态,0不在位,1在位
`CapacityMiB`	`U32`	只读	变更广播	硬盘容量，以MiB为单位
`TemperatureCelsius`	`S16`	只读	变更广播	硬盘温度，硬盘存在零下负温场景
`Model`	`String`	只读	变更广播	硬盘型号，比如MBF2300RC
`EnclosureId`	`U16`	只读	变更广播	硬盘所在背板的id，由控制器分配
`LocationIndicatorState`	`U8`	只读	变更广播	硬盘定位状态，根据locate寄存器和fault寄存器判断
`LocateLed`	`U8`	只读	变更广播	硬盘locate寄存器的值
`FaultLed`	`U8`	只读	变更广播	硬盘fault寄存器的值
`Protocol`	`U8`	只读	变更广播	硬盘接口类型：0:Unknown,1:parallel.SCSI,2:SAS,3:SATA,4:FC
`CapableSpeedGbs`	`U8`	只读	变更广播	硬盘接口速率（最大速率）
`NegotiatedSpeedGbs`	`U8`	只读	变更广播	硬盘连接速率（协商速率）
`MediaType`	`U8`	只读	变更广播	硬盘介质类型：0:HDD,1:SSD,2:SSM,255:Unknown
`FirmwareStatus`	`U8`	只读	变更广播	硬盘固件状态
`SerialNumber`	`String`	只读	变更广播	硬盘序列号
`Manufacturer`	`String`	只读	变更广播	硬盘厂商
`PowerOnHours`	`Double`	只读	变更广播	硬盘通电时间
`Revision`	`String`	只读	变更广播	硬盘固件版本
`RotationSpeedRPM`	`U16`	只读	变更广播	硬盘转速
`BlockSizeBytes`	`U16`	只读	变更广播	硬盘块大小
`SASAddress1`	`String`	只读	变更广播	硬盘SAS地址的第一部分
`SASAddress2`	`String`	只读	变更广播	硬盘SAS地址的第二部分
`PredictedMediaLifeLeftPercent`	`U8`	只读	变更广播	硬盘剩余磨损率，即剩余擦写次数的百分比（0-100，或者255表示无效）
`PredictedFailCount`	`U32`	只读	变更广播	硬盘预故障错误统计
`MediaErrorCount`	`U32`	只读	变更广播	硬盘媒介错误统计
`OtherErrorCount`	`U32`	只读	变更广播	硬盘其他错误统计
`PatrolState`	`U8`	只读	变更广播	硬盘巡检状态：0:没有巡检或巡检结束，1:巡检中，255:未知
`PowerState`	`U8`	只读	变更广播	硬件电源状态
`RebuildState`	`U8`	只读	变更广播	硬盘重构状态：0:没有重建或重建结束，1:重建中，255:未知
`RebuildProgress`	`U8`	只读	变更广播	硬盘重构进度
`BootPriority`	`U8`	只读	变更广播	硬盘启动盘优先级
`HotspareType`	`U8`	只读	变更广播	硬盘热备状态
`RefControllerId`	`U8`	只读	变更广播	关联的控制器Id
`RefVolumeList`	`U16[]`	只读	变更广播	关联的逻辑盘Id列表
`RefDiskArrayId`	`U16`	只读	变更广播	关联的硬盘阵列Id
`ManufacturerId`	`U32`	只读	变更广播	厂商Id
`PCIeLinkSpeed`	`Double`	只读	变更广播	PCIe单个通道的速率
`Location`	`String`	只读	变更广播	表示当前盘的物理位置
`DeviceName`	`String`	只读	变更广播	表示当前盘的设备名称
`ResourceId`	`U8`	只读	变更广播	表示当前盘的资源归属

方法

`SetLocationIndicatorState`

描述： 设置物理盘的定位灯状态

输入参数：

参数名	类型	描述
`LocationIndicatorState`	`U8`	定位指示灯状态 0 = Off 1 = Blinking

`SetFaultIndicatorState`

描述： 设置物理盘的故障灯状态

输入参数：

参数名	类型	描述
`FaultIndicatorState`	`U8`	故障指示灯状态 0 = Off 1 = Blinking

`SetFirmwareStatus`

描述： 设置物理盘的固件状态

输入参数：

参数名	类型	描述
`FirmwareStatus`	`U8`	固件状态

`SetHotspareType`

描述： 设置物理盘是否为热备盘

输入参数：

参数名	类型	描述
`HotspareType`	`U8`	驱动器的热备状态 0 = None 1 = Global 2 = Dedicated
`VolumeId`	`U16`	存储卷ID

`SetBootPriority`

描述： 设置物理盘的启动优先级

输入参数：

参数名	类型	描述
`BootPriority`	`U8`	启动优先级 0 = None 1 = Primary

`SetPatrolState`

描述： 设置物理盘的巡检状态

输入参数：

参数名	类型	描述
`PatrolState`	`U8`	巡检状态 0 = stop 1 = run

`CryptoErase`

描述： 支持设置物理盘被加密擦除

bmc.kepler.Systems.Storage.Drive.AddrInfo

属性

属性名	类型	可读写	信号通知	描述
`Type`	`String`	只读	变更广播	硬盘的丝印类型
`SocketId`	`U8`	只读	变更广播	硬盘的CPU归属
`SlotId`	`U8`	只读	变更广播	硬盘的槽位号
`PortId`	`U8`	只读	变更广播	硬盘的端口号
`RootBDF`	`String`	只读	变更广播	硬盘的BDF

bmc.kepler.Systems.Storage.Drive.DriveStatus

属性

属性名	类型	可读写	信号通知	描述
`Missing`	`U16`	只读	变更广播	硬盘丢失标志
`PredictiveFailure`	`U8`	只读	变更广播	预故障标志
`InAFailedArray`	`U8`	只读	变更广播	是否处于一个故障的硬盘阵列。0：否，1：是
`CapacityError`	`Boolean`	只读	变更广播	硬盘容量是否异常
`FirmwareStatusError`	`Boolean`	只读	变更广播	硬盘固件状态是否异常
`Failure`	`Boolean`	只读	变更广播	硬盘是否故障
`Health`	`U8`	只读	变更广播	硬盘健康状态

bmc.kepler.Systems.Storage.Drive.DriveSubHealth

属性

属性名	类型	可读写	信号通知	描述
`EstimatedRemainingLifespanInsufficient`	`U8`	只读	变更广播	硬盘预估剩余寿命不足
`SLCSpareBlockPercentage`	`U8`	只读	变更广播	非用户区剩余冗余块百分比
`TLCSpareBlockPercentage`	`U8`	只读	变更广播	用户区剩余冗余块百分比
`EstimatedRemainingLifespan`	`U32`	只读	变更广播	硬盘预估剩余寿命
`IODeteriorationHealthCode`	`U16`	只读	变更广播	硬盘IO性能健康码

bmc.kepler.Systems.Storage.Drive.NVMe

属性

属性名	类型	可读写	信号通知	描述
`LifeUsedPercentage`	`U8`	只读	变更广播	驱动器寿命百分比

bmc.kepler.Systems.Storage.Drive.NVMe.SMART

属性

属性名	类型	可读写	信号通知	描述
`AvailableSpare`	`U8`	只读	变更广播	驱动器可用冗余空间的百分比（0到100）
`CriticalWarning`	`U8`	只读	变更广播	控制器状态的重要的告警,bit0:表示冗余空间小于设定的阈值,bit1:表示温度超过或低于一个重要的阈值,bit2:表示由于重要的media错误，器件的可靠性已经降低,bit3:该介质已经被置为只读模式,bit4:表示控制器的易失性器件fail，该域仅在控制器内部存在易失性器件时有效,bit5-7:保留
`UsedPercentage`	`U8`	只读	变更广播	用户实际使用和厂家设定的器件寿命的百分比（0到100）
`Status`	`U8`	只读	变更广播	SMART告警状态

bmc.kepler.Systems.Storage.Drive.SAS.SMART

属性

属性名	类型	可读写	信号通知	描述
`StripTemperatureCelsius`	`U32`	只读	变更广播	驱动器条带温度(摄氏度)
`ElementsInGrownDefectList`	`U32`	只读	变更广播	增长缺陷列表(G表)中的元素
`ElementsInPrimaryDefectList`	`U32`	只读	变更广播	主缺陷列表(P表)中的元素
`ManufacturedInWeekOfYear`	`String`	只读	变更广播	生产日期：年中周
`BlocksSentToInitiator`	`U32`	只读	变更广播	发送到启动器的块
`BlocksReceivedFromInitiator`	`U32`	只读	变更广播	从启动器收到的块
`UntilNextInterSMARTTestMinutes`	`U32`	只读	变更广播	距下一次内部SMART测试的时长(分钟)
`LastPrefailEventSeqNum`	`U32`	只读	变更广播	最后一次预测故障事件的序列号

bmc.kepler.Systems.Storage.Drives

属性

属性名	类型	可读写	信号通知	描述
`MaxTemperatureCelsius`	`U8`	只读	变更广播	驱动器最高温度，用于风扇调速

方法

`CollectIODeteriorationDiagInfo`

描述： 设置启动收集硬盘IO性能诊断信息

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务Id

`GetDrivesSubHealthDiagInfo`

描述： 获取硬盘IO性能诊断信息列表

输入参数：

参数名	类型	描述
`SubHealthType`	`String`	硬盘亚健康数据类型

输出参数：

参数名	类型	描述
`SubHealthDiagInfoList`	`Array`	硬盘亚健康诊断信息列表

`GetNvmeDriveRawData`

描述： 获取NVMe盘的信息

输入参数：

参数名	类型	描述
`index`	`U16`	Nvme盘序号

输出参数：

参数名	类型	描述
`NvmeDriveData`	`String`	Nvme盘信息数据

`GetNvmeDriveCount`

描述： 获取NVMe盘的数量

输出参数：

参数名	类型	描述
`NvmeDriveCount`	`U16`	Nvme盘数量

`SetDriveSubHealthDiagResult`

描述： 设置硬盘IO性能健康码

输入参数：

参数名	类型	描述
`SubHealthDiagResult`	`Array`	硬盘亚健康信息诊断结果列表，必选参数：（DriveName：硬盘名称）可选参数：（EstimatedRemainingLifespan：硬盘预估寿命告警码，EstimatedRemainingLifespan：硬盘预估剩余寿命，IODeteriorationHealthCode：硬盘I/O性能健康码）

自定义类型

DriveList 结构：

字段名	类型	描述
key	U32
value	DiagInfoList

DiagInfoList 结构：

字段名	类型	描述
key	String
value	String

KeyValueTable 结构：

字段名	类型	描述
Key	String
Value	String

bmc.kepler.Systems.Storage.PhyError

属性

属性名	类型	可读写	信号通知	描述
`PhyId`	`U8`	只读	变更广播	PHY误码Id
`InvalidDwordCount`	`U32`	只读	变更广播	无效DWORD数
`LossDwordSyncCount`	`U32`	只读	变更广播	丢失DWORD同步数
`PhyResetProblemCount`	`U32`	只读	变更广播	PHY重启问题数
`RunningDisparityErrorCount`	`U32`	只读	变更广播	连续不均衡性错误数

bmc.kepler.Systems.Storage.SASMetrics

属性

属性名	类型	可读写	信号通知	描述
`ControllerId`	`U8`	只读	变更广播	关联的控制器序号
`InvalidDwordCount`	`U32`	只读	变更广播	无效DWORD数
`LossDwordSyncCount`	`U32`	只读	变更广播	丢失DWORD同步数
`PhyResetProblemCount`	`U32`	只读	变更广播	PHY重启问题数
`RunningDisparityErrorCount`	`U32`	只读	变更广播	连续不均衡性错误数

bmc.kepler.Systems.Storage.StorageConfig

属性

属性名	类型	可读写	信号通知	描述
`StorageConfigReady`	`U8`	只读	变更广播	用于控制器配置导入导出场景,标志了所有控制器的状态
`VolumesStateAbnormal`	`U8`	只读	变更广播	是否存在状态异常的逻辑盘。0：否，1：是
`DiskPartitionUsagePercentageThreshold`	`U8`	读写	变更广播	磁盘分区占用率告警阈值(百分比)

bmc.kepler.Systems.Storage.Volume

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U16`	只读	变更广播	逻辑盘的Id
`VolumeName`	`String`	只读	变更广播	逻辑盘的名称
`OptimumIOSizeBytes`	`U32`	只读	变更广播	逻辑盘的条带大小
`DefaultReadPolicy`	`String`	只读	变更广播	逻辑盘的默认读策略
`DefaultWritePolicy`	`String`	只读	变更广播	逻辑盘的默认写策略
`State`	`U8`	只读	变更广播	逻辑盘的状态
`RAIDType`	`U8`	只读	变更广播	逻辑盘的Raid级别
`CapacityBytes`	`U64`	只读	变更广播	逻辑盘的容量
`DriveCachePolicy`	`U8`	只读	变更广播	逻辑盘的硬盘缓存策略
`CurrentForegroundInitState`	`U8`	只读	变更广播	逻辑盘当前是否在FGI中
`ForegroundInitProgress`	`U8`	只读	变更广播	逻辑盘当前的FGI进度，百分比
`CurrentReadPolicy`	`String`	只读	变更广播	逻辑盘当前读策略
`CurrentWritePolicy`	`String`	只读	变更广播	逻辑盘当前写策略
`BootPriority`	`U8`	只读	变更广播	启动优先级
`BootEnable`	`U8`	只读	变更广播	是否为启动盘
`OSDriveName`	`String`	只读	变更广播	逻辑盘对应的OS盘符
`BGIEnable`	`U8`	只读	变更广播	后台初始化使能状态
`SSDCachecadeVolume`	`U8`	只读	变更广播	是否为CacheCade逻辑盘
`ConsistencyCheck`	`U8`	只读	变更广播	一致性检查功能的启用状态
`SSDCachingEnable`	`U8`	只读	变更广播	是否可使用CacheCade逻辑盘
`AssociatedVolumes`	`U16[]`	只读	变更广播	所关联的普通逻辑盘的访问路径
`AssociatedCacheCadeVolume`	`U16[]`	只读	变更广播	所关联的CacheCade逻辑盘的访问路径
`DefaultCachePolicy`	`String`	只读	变更广播	逻辑盘默认的Cache策略
`AccessPolicy`	`String`	只读	变更广播	逻辑盘的访问策略
`CurrentCachePolicy`	`String`	只读	变更广播	逻辑盘当前Cache策略
`CacheLineSizeKiB`	`U8`	只读	变更广播	缓存行大小
`AccelerationMethod`	`String`	只读	变更广播	加速方法
`RebuildProgress`	`U8`	只读	变更广播	指定逻辑盘数据重建进度
`InitializationMode`	`U8`	只读	变更广播	初始化模式
`RebuildState`	`U8`	只读	变更广播	指定逻辑盘数据重建状态
`RefControllerId`	`U8`	只读	变更广播	指定逻辑盘所属控制器id
`RefDriveList`	`String[]`	只读	变更广播	指定逻辑盘关联的物理盘列表
`RefDiskArrayList`	`U16[]`	只读	变更广播	指定逻辑盘关联的阵列列表
`HotSpareDriveList`	`String[]`	只读	变更广播	逻辑盘关联热备盘列表
`SpanCount`	`U8`	只读	变更广播	逻辑盘包含的子组数
`MaxResizableSizeBytes`	`U64`	只读	变更广播	逻辑盘的最大可设置的容量

方法

`SetName`

描述： 设置逻辑盘的名称

输入参数：

参数名	类型	描述
`Name`	`String`	名称

`SetReadPolicy`

描述： 设置逻辑盘的读策略

输入参数：

参数名	类型	描述
`ReadPolicy`	`U8`	读策略

`SetWritePolicy`

描述： 设置逻辑盘的写策略

输入参数：

参数名	类型	描述
`WritePolicy`	`U8`	写策略

`SetBootable`

描述： 设置逻辑盘是否启动盘

输入参数：

参数名	类型	描述
`BootPriority`	`U8`	启动优先级

`SetIOPolicy`

描述： 设置逻辑盘的IO策略

输入参数：

参数名	类型	描述
`IOPolicy`	`U8`	IO策略

`SetBGIEnable`

描述： 设置逻辑盘的后台初始化

输入参数：

参数名	类型	描述
`BGIEnabled`	`U8`	是否后台初始化

`SetAccessPolicy`

描述： 设置逻辑盘的获取策略

输入参数：

参数名	类型	描述
`AccessPolicy`	`U8`	获取策略

`SetDiskCachePolicy`

描述： 设置逻辑盘的硬盘Cache策略

输入参数：

参数名	类型	描述
`DiskCachePolicy`	`U8`	硬盘Cache策略

`StartForegroundInit`

描述： 开始前台初始化

输入参数：

参数名	类型	描述
`InitType`	`U8`	初始化类型

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`CancelForegroundInit`

描述： 取消前台初始化

输出参数：

参数名	类型	描述
`TaskId`	`U32`	任务ID

`SetCachecadeEnable`

描述： 设置Cache使能状态

输入参数：

参数名	类型	描述
`AssociateCachecade`	`U8`	关联Cache号

`SetAccelerator`

描述： 设置逻辑盘的加速方法

输入参数：

参数名	类型	描述
`Accelerator`	`U8`	加速方法

`SetCapacitySize`

描述： 设置逻辑盘的容量

输入参数：

参数名	类型	描述
`CapacitySize`	`U32`	容量大小
`CapacityUnit`	`U8`	容量单位，0:MB,1:GB,2:TB

`SetStripSize`

描述： 设置逻辑盘的条带大小

输入参数：

参数名	类型	描述
`StripSize`	`U8`	条带大小

bmc.kepler.Systems.SystemFirmwareProgress.Status

属性

属性名	类型	可读写	信号通知	描述
`KBCError`	`U8`	只读	变更广播	KBC Controller自检错误
`VideoError`	`U8`	只读	变更广播	显卡芯片异常

bmc.kepler.Systems.SystemLockDown

属性

属性名	类型	可读写	信号通知	描述
`SystemLockDownSupport`	`String`	读写	变更广播	产品是否支持系统锁定功能，通过license控制其状态
`SystemLockDownStatus`	`String`	读写	变更广播	系统锁定开关状态

bmc.kepler.Systems.TemperatureManagement

方法

`GetTemperaturesInfo`

描述： 获取温度点信息

输出参数：

参数名	类型	描述
`TemperaturesInfo`	`Array`	温度点信息

自定义类型

TemperaturesInfo 结构：

字段名	类型	描述
Name	String	温度点名称
ReadingValue	Double	温度值
Status	String	告警状态
UpperThreshold	U8[]	告警阈值上限(轻微/严重/致命)
LowerThreshold	U8[]	告警阈值下限(轻微/严重/致命)
CoordinateX	U8	温度点横坐标
CoordinateY	U8	温度点纵坐标

bmc.kepler.Systems.ThresholdSensor

属性

属性名	类型	可读写	信号通知	描述
`EntityId`	`U8`	只读	变更广播	传感器对应的实体，来自于IPMI规范，具体需要关联传感器对应的Entity.Id
`EntityInstance`	`U8`	只读	变更广播	传感器对应的实体，来自于IPMI规范，具体需要关联传感器对应的Entity.Instance
`Capabilities`	`U8`	只读	变更广播	传感器支持能力，来自于IPMI规范，具体可以参考规范 43.1
`SensorType`	`U8`	只读	变更广播	传感器类型，来自于IPMI规范，具体可以参考规范 42.2
`SensorIdentifier`	`String`	只读	变更广播	传感器标识
`SensorName`	`String`	只读	变更广播	传感器对外显示名称
`ReadingMask`	`U16`	只读	变更广播	传感器读值掩码，来自于IPMI规范，具体可以参考规范 43.1
`UpperNonrecoverable`	`U8`	只读	变更广播	传感器紧急事件上限，来自于IPMI规范，具体可以参考规范 43.1
`UpperCritical`	`U8`	只读	变更广播	传感器严重事件上限，来自于IPMI规范，具体可以参考规范 43.1
`UpperNoncritical`	`U8`	只读	变更广播	传感器一般事件上限，来自于IPMI规范，具体可以参考规范 43.1
`LowerNonrecoverable`	`U8`	只读	变更广播	传感器紧急事件下限，来自于IPMI规范，具体可以参考规范 43.1
`LowerNoncritical`	`U8`	只读	变更广播	传感器严重事件下限，来自于IPMI规范，具体可以参考规范 43.1
`LowerCritical`	`U8`	只读	变更广播	传感器一般事件下限，来自于IPMI规范，具体可以参考规范 43.1
`PositiveHysteresis`	`U8`	只读	变更广播	传感器正向迟滞量，来自于IPMI规范，具体可以参考规范 43.1
`NegativeHysteresis`	`U8`	只读	变更广播	传感器负向迟滞量，来自于IPMI规范，具体可以参考规范 43.1
`OwnerLun`	`U8`	只读	变更广播	传感器的Lun，默认0，来自于IPMI规范，具体可以参考规范 43.1
`SensorNumber`	`U8`	只读	变更广播	传感器编号，默认255，来自于IPMI规范，由BMC自行生成；如果需要特殊的编号，则需要单独在传感器定制化进行定制（BMC正常运行时插入的部件的传感器不支持定制）
`Reading`	`U8`	只读	变更广播	传感器原始读值，引用传感器的数据源（如Scanner）读值同步，需要填写一个默认值，用于数据源未更新时显示，需要注意在门限之内，防止产生SEL事件
`ReadingStatus`	`U8`	只读	变更广播	传感器读值状态，默认0，引用传感器的数据源（如Scanner）读值状态同步
`OriginalReading`	`Double`	只读	变更广播	传感器的原始值，当线型标志配置0x70-0x7f时，需要此属性配合Reading(固定配置170)计算传感器读数系数以提升读值精度至1w

bmc.kepler.Systems.ThresholdSensorDisplay

属性

属性名	类型	可读写	信号通知	描述
`UpperNonrecoverableDisplay`	`String`	只读	变更广播	传感器紧急门限上限可读描述，精度3位有效数字
`UpperCriticalDisplay`	`String`	只读	变更广播	传感器严重门限上限可读描述，精度3位有效数字
`UpperNoncriticalDisplay`	`String`	只读	变更广播	传感器一般门限上限可读描述，精度3位有效数字
`LowerNonrecoverableDisplay`	`String`	只读	变更广播	传感器紧急门限下限可读描述，精度3位有效数字
`LowerNoncriticalDisplay`	`String`	只读	变更广播	传感器严重门限下限可读描述，精度3位有效数字
`LowerCriticalDisplay`	`String`	只读	变更广播	传感器一般门限下限可读描述，精度3位有效数字
`PositiveHysteresisDisplay`	`String`	只读	变更广播	传感器正向迟滞量可读描述，精度3位有效数字
`NegativeHysteresisDisplay`	`String`	只读	变更广播	传感器负向迟滞量可读描述，精度3位有效数字
`ReadingDisplay`	`String`	读写	变更广播	传感器读值可读描述，精度3位有效数字
`UnitDisplay`	`String`	只读	变更广播	传感器单位可读描述
`Status`	`String`	只读	变更广播	传感器当前状态：Enabled：传感器使能；Disabled：传感器禁用；InTest：传感器测试中；Starting：传感器更新中
`Health`	`String`	只读	变更广播	传感器健康状态：Critical：紧急；Major：严重；Minor：一般；OK：正常
`AssertStatus`	`U16`	只读	变更广播	传感器SEL事件状态，16进制的数，bit4 - bit15依次对应12种门限事件状态，1：Assert；0：Deassert

bmc.kepler.Systems.UnitConfigError

属性

属性名	类型	可读写	信号通知	描述
`Port1LinkInfo`	`String`	读写	变更广播	端口1连接信息
`Port1Status`	`U8`	读写	变更广播	端口1状态（0：正常、1：组件配置错误）
`Port2LinkInfo`	`String`	读写	变更广播	端口2连接信息
`Port2Status`	`U8`	读写	变更广播	端口2状态
`AbsenceAllowed`	`U8`	只读	变更广播	是否允许组件设备不在位（0：不允许不在位，当不在位时产生该告警、1：允许不在位，不产生告警）

bmc.kepler.Systems.VrdChip

属性

属性名	类型	可读写	信号通知	描述
`Name`	`String`	读写	变更广播	芯片名称 Type+No
`Vendor`	`String`	读写	变更广播	芯片厂商
`Type`	`String`	读写	变更广播	芯片类型
`FirmwareVersion`	`String`	读写	变更广播	固件版本

bmc.kepler.Systems.VrdMgmt

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统Id
`Health`	`U8`	只读	变更广播	健康状态
`Status`	`U8`	只读	变更广播	Vrd值为无效值时，Status置为0，有效值时，置位为1
`CpuId`	`U8`	只读	变更广播	所关联的CPU id
`Cpu0v9TACore`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为CORE，DieId为1
`Cpu0v75DDRVDD`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为DDR，无DieId
`Cpu0v9TBCore`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为CORE，DieId为3
`Cpu0v9Uncore`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为UNCORE，无DieId
`Cpu0v8NADVDD`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为Nimbus，DieId为0
`Cpu0v8NBDVDD`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为Nimbus，DieId为2
`Cpu1v1DDRVddq`	`Double`	读写	变更广播	Vrd供电信息，供电区域类型为VDDQ，无DieId
`CpuTACoreTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为CORE，DieId为1
`CpuDDRVDDTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为DDR，无DieId
`CpuTBCoreTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为CORE，DieId为3
`CpuUncoreTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为UNCORE，无DieId
`CpuNADVDDTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为Nimbus，DieId为0
`CpuNBDVDDTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为Nimbus，DieId为2
`CpuDDRVddqTemp`	`Double`	读写	变更广播	临时Vrd供电信息，供电区域类型为VDDQ，无DieId
`VrdTemperatureCelsius`	`Double`	只读	变更广播	Vrd温度，用作调速
`Watts`	`Double`	读写	变更广播	功率

bmc.kepler.Systems.VrdPower

属性

属性名	类型	可读写	信号通知	描述
`SystemId`	`U8`	只读	变更广播	系统id
`CpuId`	`U8`	只读	变更广播	cpu index取值范围为0 ~ n
`Type`	`U8`	只读	变更广播	电源供电区域类型, 0: Core, 1: Uncore, 2: DDr, 3: Nimbus, 4: VDDQ
`DieId`	`U8`	只读	变更广播	电源供电die区域, 0: NA, 1: TA, 2: NB, 3: TB, 255: 不涉及
`Voltage`	`Double`	只读	变更广播	电源电压，单位 V
`CurrentAmps`	`Double`	只读	变更广播	电源电流，单位 A
`TemperatureCelsius`	`Double`	只读	变更广播	电源温度，单位℃

bmc.kepler.TaskService.Task

属性

属性名	类型	可读写	信号通知	描述
`Id`	`U32`	只读	变更广播	任务id
`Name`	`String`	只读	变更广播	任务名称
`StartTime`	`String`	只读	变更广播	任务开始时间
`EndTime`	`String`	只读	变更广播	任务结束时间
`Progress`	`U32`	只读	变更广播	任务进度
`State`	`String`	只读	变更广播	任务的状态
`Status`	`String`	只读	变更广播	任务的级别
`Parameters`	`String`	只读	变更广播	消息参数说明
`MessageId`	`String`	只读	变更广播	消息id
`MessageArgs`	`String[]`	只读	变更广播	消息参数

bmc.kepler.TelemetryService

属性

属性名	类型	可读写	信号通知	描述
`MaxReports`	`U8`	只读	变更广播	TelemetryService服务支持的最大MetricReport数
`MinCollectionInterval`	`String`	只读	变更广播	TelemetryService服务支持最小采集间隔
`ServiceEnabled`	`Boolean`	读写	变更广播	TelemetryService服务使能状态

方法

`SubmitTestMetricReport`

描述： 上报测试的MetricReport

输入参数：

参数名	类型	描述
`MetricReports`	`Array`	上报测试的MetricReport请求体的键值表,键的值包括:MetricDefinition、MetricId、MetricProperty、MetricValue、Timestamp
`MetricReportName`	`String`	上报测试的MetricReport的名称

自定义类型

MetricReportObject 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.TelemetryService.MetricDefinitions

方法

`GetMetricDefinitionById`

描述： 根据Id获取指定的MetricDefinition信息

输入参数：

参数名	类型	描述
`Id`	`String`	MetricDefinition的Id

输出参数：

参数名	类型	描述
`MetricDefinition`	`String`	MetricDefinition的json字符串

`GetMetricDefinitions`

描述： 获取所有的MetricDefinition信息

输入参数：

参数名	类型	描述
`Skip`	`U16`	跳过MetricDefinition的数目
`Top`	`U16`	获取MetricDefinition的数目

输出参数：

参数名	类型	描述
`MetricDefinitions`	`String[]`	MetricDefinitions的Id集合信息

bmc.kepler.TelemetryService.MetricReportDefinition

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	MetricReportDefinition的Id
`Name`	`String`	只读	变更广播	MetricReportDefinition的名称
`Description`	`String`	只读	变更广播	MetricReportDefinition的描述
`AppendLimit`	`U16`	只读	变更广播	单个MetricReport允许记录数据的最大条数
`MetricReportDefinitionEnabled`	`Boolean`	读写	变更广播	MetricReportDefinition的使能状态，关闭后自身和Trigger触发都不再产生MetricReport
`MetricReportDefinitionType`	`String`	读写	变更广播	产生MetricReport的方式:OnChange-采集项取值变化时产生;OnRequest-查询MetricReport时产生;Periodic-周期性产生，需要指定Schedule
`Metrics`	`Array`	读写	变更广播	呈现在MetricReport中的采集项定义列表
`ReportActions`	`String[]`	读写	变更广播	产生新的MetricReport之后需要做的动作,LogToMetricReportsCollection-记录在对应MetricReport资源中;RedfishEvent-通过redfish事件上报给订阅者
`ReportUpdates`	`String`	读写	变更广播	用于指定当单个MetricReport达到容量上限之后如何更新后续的Report,AppendWrapsWhenFull-使用新记录覆盖旧记录
`InitialStartTime`	`U64`	读写	变更广播	Schedule配置，采集起始时间
`Lifetime`	`String`	读写	变更广播	Schedule配置，采集数据的最大时长
`MaxOccurrences`	`U32`	读写	变更广播	Schedule配置，最大采集次数
`RecurrenceInterval`	`String`	读写	变更广播	Schedule配置，收集数据的时间间隔

方法

`DeleteMetricReportDefinition`

描述： 删除MetricReportDefinition信息

自定义类型

MetricsItem 结构：

字段名	类型	描述
CollectionDuration	String	对原始指标进行统计计算的持续时间
CollectionFunction	String	对MetricProperties中指定的原始指标在CollectionDuration时间范围内进行的统计计算算法,Average-求平均值;Maximum-求最大值;Minimum-求最小值;Summation-求和.
CollectionTimeScope	String	统计计算作用的时间范围,Interval-周期性采集，通过CollectionDuration指定进行统计计算时作用的周期;Point-指定某个时间点进行采集
MetricId	String	采集项的标识符

bmc.kepler.TelemetryService.MetricReportDefinitions

方法

`NewMetricReportDefinition`

描述： 创建MetricReportDefinition

输入参数：

参数名	类型	描述
`MetricReportDefinition`	`String`	创建MetricReportDefinition的入参json字符串

`ResetToDefaults`

描述： 恢复所有MetricReportDefinition到预设状态

bmc.kepler.TelemetryService.MetricReports

方法

`ClearMetricReports`

描述： 清除所有的MetricReport

`GetMetricReportById`

描述： 根据Id获取指定的MetricReport信息

输入参数：

参数名	类型	描述
`Id`	`String`	MetricReport的Id

输出参数：

参数名	类型	描述
`MetricReport`	`String`	MetricReport的json字符串

`GetMetricReports`

描述： 获取所有的MetricReport信息

输入参数：

参数名	类型	描述
`Skip`	`U16`	跳过MetricReport的数目
`Top`	`U16`	获取MetricReport的数目

输出参数：

参数名	类型	描述
`MetricReports`	`String[]`	MetricReports的Id集合信息

bmc.kepler.TelemetryService.Triggers

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	Triggers的Id
`Name`	`String`	只读	变更广播	Triggers的名称
`Description`	`String`	只读	变更广播	Triggers的描述
`MetricReportDefinitions`	`String[]`	读写	变更广播	TriggersActions属性包含RedfishMetricReport时,Triggers门限条件触发,需要生成的MetricReport的定义集合
`MetricIds`	`String[]`	读写	变更广播	Triggers关联的MetricDefinition的Id集合
`MetricType`	`String`	只读	变更广播	Triggers的支持的指标类型,Numeric-数值型
`LowerCriticalActivation`	`String`	读写	变更广播	触发LowerCritical阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
`LowerCriticalDwellTime`	`String`	读写	变更广播	触发LowerCritical阈值迟滞时间
`LowerCriticalReading`	`Double`	读写	变更广播	LowerCritical阈值
`LowerWarningActivation`	`String`	读写	变更广播	触发LowerWarning阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
`LowerWarningDwellTime`	`String`	读写	变更广播	触发LowerWarning阈值迟滞时间
`LowerWarningReading`	`Double`	读写	变更广播	LowerWarning阈值
`UpperCriticalActivation`	`String`	读写	变更广播	触发UpperCritical阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
`UpperCriticalDwellTime`	`String`	读写	变更广播	触发UpperCritical阈值迟滞时间
`UpperCriticalReading`	`Double`	读写	变更广播	UpperCritical阈值
`UpperWarningActivation`	`String`	读写	变更广播	触发UpperWarning阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
`UpperWarningDwellTime`	`String`	读写	变更广播	触发UpperWarning阈值迟滞时间
`UpperWarningReading`	`Double`	读写	变更广播	UpperWarning阈值
`TriggerActions`	`String[]`	只读	变更广播	Triggers触发时的操作
`TriggerEnabled`	`Boolean`	读写	变更广播	Triggers的使能状态

方法

`DeleteTriggers`

描述： 删除Triggers信息

bmc.kepler.TelemetryService.TriggersCollection

方法

`NewTriggers`

描述： 创建Triggers

输入参数：

参数名	类型	描述
`Triggers`	`String`	创建Triggers的入参json字符串

`ResetToDefaults`

描述： 恢复所有Triggers到预设状态

bmc.kepler.ThermalMgmt

方法

`SetFanPWM`

描述： 设置风扇转速

输入参数：

参数名	类型	描述
`SystemId`	`U8`	系统Id
`FanId`	`U8`	风扇Id
`PWM`	`Double`	风扇转速占空比

输出参数：

参数名	类型	描述
`Result`	`U8`	返回结果，0：设置成功；1：设置失败

bmc.kepler.UpdateService

属性

属性名	类型	可读写	信号通知	描述
`UpgradeKeyDomainId`	`U32`	只读	变更广播	固件升级解包使用的密钥的domain id
`UpgradingFlag`	`Boolean`	只读	变更广播	标识当前是否存在升级任务
`ParallelSupported`	`Boolean`	只读	变更广播	标识当前版本是否支持并行升级

方法

`StartUpgrade`

描述： 启动固件升级接口

输入参数：

参数名	类型	描述
`FilePath`	`String`	升级包路径
`Parameters`	`Object`	固件升级可选参数，用于各种子固件扩展场景

输出参数：

参数名	类型	描述
`TaskId`	`U32`	升级任务ID

`PrepareReply`

描述： 回复prepare动作结果

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`VersionStr`	`String`	版本字符串
`PrepareResult`	`S32`	准备结果

`ProcessReply`

描述： 回复process动作结果

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`ProcessResult`	`S32`	处理结果

`FinishReply`

描述： 回复finish动作结果

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`FinishResult`	`S32`	完成结果

`UpdateUpgradeStatus`

描述： 固件子模块上报升级状态

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`ResultCode`	`S32`	int32 结果码，取值：0-OK，-1代表失败，其他值统一规划
`Progress`	`S32`	升级进度，为0到100的值
`ResultDetail`	`String`	结果详细表述，对结果码进行更详细的解释

`GetUpgradeStatus`

描述： 获取升级状态

输入参数：

参数名	类型	描述
`TaskId`	`U32`	任务标识

输出参数：

参数名	类型	描述
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`ResultCode`	`S32`	成功为0，失败为-1
`Progress`	`S32`	进度0-100
`ResultDetail`	`String`	结果详细表述，对结果码进行更详细的解释

`Rollback`

描述： 回滚特定固件

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`Id`	`String`	固件名称，同类型固件名称相同

`Export`

描述： 导出特定固件

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`Id`	`String`	固件名称，同类型固件名称相同

`CheckFirmwareType`

描述： 校验升级包的固件类型是否符合预期

输入参数：

参数名	类型	描述
`FilePath`	`String`	升级包的路径
`FirmwareType`	`String`	升级包的预期固件类型

输出参数：

参数名	类型	描述
`IsMatch`	`Boolean`	升级包与预期固件类型是否匹配

`ParseFirmwarePackage`

描述： 完成FilePath下的hpm包的完整性校验以及CMS验签

输入参数：

参数名	类型	描述
`FilePath`	`String`	需要解压的hpm包的地址

输出参数：

参数名	类型	描述
`FirmwareType`	`String`	解压后的固件包的type
`FirmwareDirectory`	`String`	解压后的固件升级文件的位置

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.UpdateService.Certificate

方法

`ImportCRL`

描述： 导入自定义的固件版本签名证书的CRL列表，导入之后持久化保存；导入的CRL用作固件升级时CMS签名的证书吊销校验

输入参数：

参数名	类型	描述
`URI`	`String`	导入自定义的吊销列表的路径，支持远程传输和本地传输

输出参数：

参数名	类型	描述
`TaskId`	`U32`	Import Crl Task Id

bmc.kepler.UpdateService.FirmwareActive

方法

`StartActive`

描述： 启动固件生效

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID

输出参数：

参数名	类型	描述
`TaskId`	`U32`	生效任务标识

`RegisterActiveAction`

描述： 注册生效动作

输入参数：

参数名	类型	描述
`ActiveAction`	`Array`	各固件调用此方法向firmware_mgmt注册生效条件、生效动作

`UpdateActiveStatus`

描述： 更新生效状态

输入参数：

参数名	类型	描述
`ActiveStatus`	`Array`	各固件调用此方法向firmware_mgmt更新生效状态

`ActiveProcessReply`

描述： 回复生效处理结果

输入参数：

参数名	类型	描述
`SystemId`	`S32`	系统ID
`FirmwareType`	`String`	固件的类型信息，由固件管理统一分配管理
`ProcessResult`	`S32`	处理结果

自定义类型

KeyValueTable 结构：

字段名	类型	描述
Key	String
Value	String

bmc.kepler.UpdateService.FirmwareActiveInfo

属性

属性名	类型	可读写	信号通知	描述
`FirmwareId`	`String`	只读	变更广播	SystemId+固件类型(FirmwareType)
`FirmwareType`	`String`	只读	变更广播	固件类型
`ActiveCondition`	`String`	只读	变更广播	生效条件
`ActiveMode`	`String`	只读	变更广播	生效模式
`ActiveStatus`	`String`	读写	变更广播	生效状态
`SystemId`	`String`	只读	变更广播	系统host id

bmc.kepler.UpdateService.FirmwareInfo

属性

属性名	类型	可读写	信号通知	描述
`Id`	`String`	只读	变更广播	固件名称，同类型固件名称相同
`Name`	`String`	只读	变更广播	相同固件名称的固件可能有多个，在Description中区分
`Version`	`String`	读写	变更广播	固件版本号
`BuildNum`	`String`	只读	变更广播	固件构建版本
`ReleaseDate`	`String`	读写	变更广播	固件发布时间
`LowestSupportedVersion`	`String`	只读	变更广播	固件支持的最低版本，可用于防回退
`SoftwareId`	`String`	只读	变更广播	软件识别标签
`Manufacturer`	`String`	只读	变更广播	固件发布厂商名
`Updateable`	`Boolean`	只读	变更广播	固件是否支持更新
`Location`	`String`	只读	变更广播	固件加载的位置
`RollbackStatus`	`String`	读写	变更广播	回滚状态
`ActiveMode`	`String`	读写	变更广播	生效方式
`Parameters`	`Object`	读写	变更广播	升级任务的附加参数
`State`	`String`	读写	变更广播	当前固件的使能状态
`Severity`	`String`	读写	变更广播	固件或硬件的健康状态
`MaxPackageSizeMiB`	`S32`	只读	变更广播	固件升级所需tmp目录最小空间，单位（MB）

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.UpdateService.FirmwareInventory

方法

`Add`

描述： 添加固件列表

输入参数：

参数名	类型	描述
`FirmwareInfoTable`	`Object`	固件基本信息
`Updateable`	`Boolean`	固件是否支持更新
`Capability`	`U16`	固件支持的能力，每个bit标识一种能力，1 支持，0 不支持：固件信息查询、固件升级生效、固件回滚、固件导出、升级生效分离
`MaxPackageSizeMiB`	`S32`	此固件升级所需tmp目录最小空间，单位（MB）

`Delete`

描述： 删除固件

输入参数：

参数名	类型	描述
`Id`	`String`	固件名称，同类型固件名称相同

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	String

bmc.kepler.UpdateService.FirmwareMatchRules

方法

`AddMatchRules`

描述： 机型校验需要获取系统的ProductId、BoardId、Uid

输入参数：

参数名	类型	描述
`Rules`	`Array`	product_mgmt调用此方法给firmware_mgmt发送属性值

自定义类型

KeyValueTable 结构：

字段名	类型	描述
Key	String
Value	String

bmc.kepler.UpdateService.ManagerVersion

属性

属性名	类型	可读写	信号通知	描述
`PlatformMajorVersion`	`String`	只读	变更广播	BMC的平台软件主版本号，只读属性，不会随着定制版本发生变化，V3版本统一默认为5
`MajorVersion`	`String`	只读	变更广播	主要版本
`MinorVersion`	`String`	只读	变更广播	次要版本
`Version`	`String`	只读	变更广播	组件版本

bmc.kepler.UpdateService.UpdateMgmt

属性

属性名	类型	可读写	信号通知	描述
`DowngradeAllowed`	`Boolean`	读写	变更广播	降级允许使能开关
`RestoreFactorySettingsOption`	`U8`	读写	变更广播	升级BMC固件前配置清除配置项信息的选项，1：只保留固件BOOT区，2：只保留固件配置区，3：保留固件BOOT区和配置区，4：不保留固件的BOOT区和配置区，0：默认值，保持BMC原升级策略
`RevokedVersions`	`String[]`	只读	变更广播	自定义吊销版本号集合，最大规格100个
`RevokedVersionEnabled`	`Boolean`	读写	变更广播	自定义吊销版本号功能开关，默认为false
`ActiveImage`	`U8`	只读	变更广播	标识当前处于active状态的镜像；0x01：Image1，0x02：Image2
`LastAction`	`U8`	只读	变更广播	记录上一次触发BMC重启的动作；0x00：NoAction，0x01：Upgrade，0x02：Rollback
`LastUpgradeResult`	`U8`	只读	变更广播	标识上一次升级是否升级并重启成功；0x00：未执行升级，0x01：升级成功，0x02：升级失败

方法

`AddRevokedVersions`

描述： 增加需要吊销的版本号

输入参数：

参数名	类型	描述
`Versions`	`String[]`	需要增加的吊销的版本列表，版本号单个版本长度限制为32，仅允许字符串、下划线、分隔符‘.’

`RemoveRevokedVersions`

描述： 删除需要吊销的版本号

输入参数：

参数名	类型	描述
`Versions`	`String[]`	需要删除的吊销的版本列表，版本号单个版本长度限制为32，仅允许字符串、下划线、分隔符‘.’

`ClearRevokedVersions`

描述： 清空所有的吊销的版本

自定义类型

Object 结构：

字段名	类型	描述
key	String
value	Boolean

bmc.kepler.Watchdog2.Status

属性

属性名	类型	可读写	信号通知	描述
`DoNotLog`	`U8`	只读	变更广播	是否记录日志
`TimerUse`	`U8`	只读	变更广播	看门狗用途
`TimerUseStr`	`String`	只读	变更广播	看门狗用途字符串描述
`SystemStartupState`	`U8`	读写	变更广播	Bios启动状态,由bios组件设置
`Running`	`U8`	只读	变更广播	是否运行
`PreTimeoutInterruptFlag`	`U8`	只读	变更广播	是否预超时
`PreTimeoutInterruptType`	`U8`	只读	变更广播	预超时中断类型
`PreTimeoutInterruptEnabled`	`Boolean`	只读	变更广播	预超时使能
`PreTimeoutInterruptInterval`	`U8`	只读	变更广播	预超时时间
`TimeoutAction`	`U8`	只读	变更广播	超时动作
`OEMExpirationFlag`	`U8`	只读	变更广播	OEM阶段超时标志
`SMSExpirationFlag`	`U8`	只读	变更广播	SMS阶段超时标志
`OSLoadExpirationFlag`	`U8`	只读	变更广播	OSLoad超时标志
`BIOSPOSTExpirationFlag`	`U8`	只读	变更广播	BIOS POST阶段超时标志
`BIOSFRB2ExpirationFlag`	`U8`	只读	变更广播	BIOS FRB2超时标志
`InitialCountdown`	`U16`	只读	变更广播	初始化计时时间
`PresentCountdown`	`U16`	只读	变更广播	当前倒计时时间
`BIOSFailToStartFlag`	`U8`	只读	变更广播	BIOS 启动失败标志
`ExpirationEventData`	`U32`	只读	变更广播	看门狗超时状态,用于IPMI规范的Watchdog2的标准离散超超时事件.byte3-0分别填充：离散事件产生的方向，0：恢复，非0：产生;0xff;看门狗属性TimerUse;看门狗属性TimeoutAction

bmc.kepler.thermal_mgmt

方法

`SetFanPWM`

描述： 设置风扇转速

输入参数：

参数名	类型	描述
`SystemId`	`U8`	系统Id
`FanId`	`U8`	风扇Id
`PWM`	`Double`	风扇转速占空比

输出参数：

参数名	类型	描述
`Result`	`U8`	返回结果，0：设置成功；1：设置失败

bmc.kepler.Accessor ​

属性 ​

bmc.kepler.AccountService ​

属性 ​

方法 ​

ImportWeakPasswordDictionary ​

ExportWeakPasswordDictionary ​

GetRequestedPublicKey ​

RecoverAccount ​

bmc.kepler.AccountService.AccountPolicy ​

属性 ​

bmc.kepler.AccountService.Authentication ​

属性 ​

方法 ​

Authenticate ​

自定义类型 ​

bmc.kepler.AccountService.Authentication.RMCP ​

方法 ​

GenRakp2AuthCode ​

AuthRakp3 ​

GenSik ​

GenRmcpAuthCode ​

CheckRmcpAuthCode ​

bmc.kepler.AccountService.Authorization ​

方法 ​

LoginRuleCheck ​

bmc.kepler.AccountService.CertificateAuthentication ​

属性 ​

bmc.kepler.AccountService.Kerberos ​

属性 ​

方法 ​

ImportKeyTable ​

bmc.kepler.AccountService.LDAP ​

属性 ​

bmc.kepler.AccountService.LDAP.LDAPController ​

属性 ​

方法 ​

SetBindDnPassword ​

bmc.kepler.AccountService.LocalAccountAuthN ​

方法 ​

LocalAuthenticate ​

VncAuthenticate ​

GenRmcp20Code ​

GenRmcp15Code ​

自定义类型 ​

bmc.kepler.AccountService.ManagerAccount ​

属性 ​

方法 ​

Delete ​

ChangePwd ​

ChangeSnmpPwd ​

ImportSSHPublicKey ​

DeleteSSHPublicKey ​

SetLastLogin ​

自定义类型 ​

bmc.kepler.AccountService.ManagerAccount.SnmpUser ​

属性 ​

方法 ​

SetAuthenticationProtocol ​

SetEncryptionProtocol ​

GetSnmpKeys ​

自定义类型 ​

bmc.kepler.AccountService.ManagerAccounts ​

方法 ​

New ​

NewOEMAccount ​

GetIdByUserName ​

GetUidGidByUserName ​

SetAccountWritable ​

GetAccountWritable ​

SetAccountLockState ​

自定义类型 ​

bmc.kepler.AccountService.PasswordPolicy ​

属性 ​

bmc.kepler.AccountService.RemoteGroup ​

属性 ​

方法 ​

Delete ​

bmc.kepler.AccountService.RemoteGroups ​

方法 ​

bmc.kepler.Accessor

属性

bmc.kepler.AccountService

属性

方法

`ImportWeakPasswordDictionary`

`ExportWeakPasswordDictionary`

`GetRequestedPublicKey`

`RecoverAccount`

bmc.kepler.AccountService.AccountPolicy

属性

bmc.kepler.AccountService.Authentication

属性

方法

`Authenticate`

自定义类型

bmc.kepler.AccountService.Authentication.RMCP

方法

`GenRakp2AuthCode`

`AuthRakp3`

`GenSik`

`GenRmcpAuthCode`

`CheckRmcpAuthCode`

bmc.kepler.AccountService.Authorization

方法

`LoginRuleCheck`

bmc.kepler.AccountService.CertificateAuthentication

属性

bmc.kepler.AccountService.Kerberos

属性

方法

`ImportKeyTable`

bmc.kepler.AccountService.LDAP

属性

bmc.kepler.AccountService.LDAP.LDAPController

属性

方法

`SetBindDnPassword`

bmc.kepler.AccountService.LocalAccountAuthN

方法

`LocalAuthenticate`

`VncAuthenticate`

`GenRmcp20Code`

`GenRmcp15Code`

自定义类型

bmc.kepler.AccountService.ManagerAccount

属性

方法

`Delete`

`ChangePwd`

`ChangeSnmpPwd`

`ImportSSHPublicKey`

`DeleteSSHPublicKey`

`SetLastLogin`

自定义类型

bmc.kepler.AccountService.ManagerAccount.SnmpUser

属性

方法

`SetAuthenticationProtocol`

`SetEncryptionProtocol`

`GetSnmpKeys`

自定义类型

bmc.kepler.AccountService.ManagerAccounts

方法

`New`

`NewOEMAccount`

`GetIdByUserName`

`GetUidGidByUserName`

`SetAccountWritable`

`GetAccountWritable`

`SetAccountLockState`

自定义类型

bmc.kepler.AccountService.PasswordPolicy

属性

bmc.kepler.AccountService.RemoteGroup

属性

方法

`Delete`

bmc.kepler.AccountService.RemoteGroups

方法