资源协作接口
更新时间:2025/7/1
在Gitcode上查看源码

bmc.kepler.Accessor

==属性==

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

bmc.kepler.AccountService

==属性==

属性名类型可读写信号通知描述
AccountLockoutCounterResetAfterS32读写变更广播账户上次登陆失败后,锁定计数器重置剩余时间
AccountLockoutCounterResetEnabledBoolean读写变更广播账户在AccountLockoutCounterResetAfter到期后是否重置
AuthFailureLoggingThresholdS32读写变更广播未使用
MaxPasswordLengthS32只读变更广播密码最长默认为20位
MinPasswordLengthS32读写变更广播密码最短长度
ServiceEnabledBoolean读写变更广播未使用
PasswordComplexityEnableBoolean读写变更广播密码复杂度检查开关
InitialPasswordPromptEnableBoolean读写变更广播BMC支持生产定制化关闭首次登录修改密码提示功能
InitialAccountPrivilegeRestrictEnabledBoolean读写变更广播初始账户权限限制开关
MinPasswordValidDaysU32读写变更广播密码最短有效期
MaxPasswordValidDaysU32读写变更广播密码最长有效期
EmergencyLoginAccountIdU8读写变更广播逃生用户
SNMPv3TrapAccountIdU8读写变更广播SNMPv3Trap用户
InactiveDaysThresholdU32读写变更广播用户不活跃阈值
WeakPasswordDictionaryEnabledBoolean读写变更广播弱口令字典使能开关
HistoryPasswordCountU8读写变更广播检查历史密码数
InitialPasswordNeedModifyBoolean读写变更广播初始密码需要强制修改
HostUserManagementEnabledBoolean读写变更广播业务侧用户管理使能
OSAdministratorPrivilegeEnabledBoolean读写变更广播业务侧管理员权限使能:true表示允许执行业务侧发送的(权限为用户管理、安全配置、调试诊断的)ipmi命令;false表示禁止执行业务侧发送的(权限为用户管理、安全配置、调试诊断)ipmi命令
SNMPv3TrapAccountLimitPolicyU8读写变更广播根据trap使能状态和版本,调整对snmpv3trap用户的修改策略.
UserNamePasswordPrefixCompareEnabledBoolean读写变更广播密码与用户名前n个字节比较策略使能
UserNamePasswordPrefixCompareLengthU8读写变更广播密码与用户名前n个字节比较策略长度

==方法==


ImportWeakPasswordDictionary

导入弱口令字典

参数

  • Path: String

返回值

  • TaskId: U32 - 仅远程上传涉及,任务id

ExportWeakPasswordDictionary

导出弱口令字典

参数

  • Path: String

返回值

  • TaskId: U32 - 仅远程上传涉及,任务id

GetRequestedPublicKey

web接口登录获取公钥,仅web_backend调用

参数

  • PublicKeyUsageType: U8 - 公钥用途,当前将支持web前端加密公钥:1

返回值

  • PublicKey: String - 公钥字符串

RecoverAccount

根据用户传入id恢复还原点用户信息

参数

  • AccountId: U8
  • Policy: U8

bmc.kepler.AccountService.AccountPolicy

==属性==

属性名类型可读写信号通知描述
NamePatternString读写变更广播用户名正则规则
AllowedLoginInterfacesString[]读写变更广播允许本地用户开启的登录接口
VisibleBoolean读写变更广播标识某类型用户前端是否呈现
DeletableBoolean读写变更广播标识某类型用户是否可删除

bmc.kepler.AccountService.Authentication

==属性==

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

==方法==


Authenticate

认证接口

参数

  • UserName: String - 用户名
  • Password: U8[] - 密码
  • Domain: String - 标识登录域名

返回值

  • UserId: S32
  • Privileges: String[]
  • RoleId: U8
  • ExtraData: ExtraDataDict

==自定义类型==


AuthType: 枚举类型

  • 0: Local
  • 1: ldap_auto_match
  • 2: ldap_server1
  • 3: ldap_server2
  • 4: ldap_server3
  • 5: ldap_server4
  • 6: ldap_server5
  • 7: ldap_server6
  • 12: ldap_kerberos_sso
  • 13: kerberos_server
  • 14: sso_local
  • 15: sso_ldap
  • 255: auto_match

RmcpAuthAlgo: 枚举类型

  • 0: None
  • 1: HmacSha1
  • 2: HmacMd5
  • 3: HmacSha2

SessionLogoutType: 枚举类型

  • 0: SessionLogout
  • 1: SessionTimeout
  • 2: SessionKickout
  • 3: SessionRelogin
  • 4: AccountConfigChange
  • 5: BMCConfigChange

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

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播双因素认证使能(证书认证)
OCSPEnabledBoolean读写变更广播联机证书状态检查使能(Online Certificate Status Protocol)
InterChassisAuthEnabledBoolean读写变更广播柜内设备间内部鉴权使能
InterChassisValidationString读写变更广播柜内设备间内部鉴权请求校验策略

bmc.kepler.AccountService.Kerberos

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播Kerberos使能
AddressString读写变更广播Kerberos服务器地址
PortS32读写变更广播Kerberos端口
RealmString读写变更广播Kerberos领域

==方法==


ImportKeyTable

导入Keytab秘钥

参数

  • Path: String

bmc.kepler.AccountService.LDAP

==属性==

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

bmc.kepler.AccountService.LDAP.LDAPController

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播LDAP域控制器使能
HostAddrString读写变更广播LDAP服务器地址
PortS32读写变更广播LDAPS端口
UserDomainString读写变更广播LDAP服务域名
FolderString读写变更广播用户应用文件夹
BindDNString读写变更广播代理用户
CertVerifyEnabledBoolean读写变更广播证书校验使能
CertVerifyLevelU8读写变更广播证书校验级别, 2-Demand, 3-Allow

==方法==


SetBindDnPassword

设置代理用户密码

参数

  • Password: U8[]

bmc.kepler.AccountService.LocalAccountAuthN

==方法==


LocalAuthenticate

本地用户认证

参数

  • UserName: String
  • Password: U8[]
  • Config: Config

返回值

  • AccountData: AccountData

VncAuthenticate

vnc用户认证

参数

  • CipherText: String - 密文
  • AuthChallenge: String - 挑战码

返回值

  • AccountData: AccountData

GenRmcp20Code

IPMI2.0 rmcp+认证,根据用户密码一次生成三个认证参数

参数

  • AuthAlgo: U8 - 加密算法
  • UserName: String - 用户名
  • ConsoleSid: U32 - 控制台端会话id
  • ManagedSid: U32 - 服务端系统身份id
  • ConsoleRandom: U8[] - 控制随机数
  • ManagedRandom: U8[] - BMC随机数
  • ManagedGuid: U8[] - 服务端设备身份id
  • Role: U8 - 角色权限
  • Ip: String - IP地址

返回值

  • Rap2AuthCode: U8[]
  • Sik: U8[]
  • Rap3AuthCode: U8[]

GenRmcp15Code

IPMI1.5版本用户认证方法

参数

  • AuthAlgo: U8 - 加密算法
  • PayLoad: U8[] - 有效负载
  • AccountId: U8 - 用户id
  • SessionId: U32 - 会话id
  • SessionSequence: U32 - RMCP会话的序列号

返回值

  • AuthCode: U8[]

==自定义类型==


Config: 结构体类型

  • key: String
  • value: Boolean

AccountData: 结构体类型

  • key: String
  • value: String

bmc.kepler.AccountService.ManagerAccount

==属性==

属性名类型可读写信号通知描述
AccountExpirationString只读变更广播账户过期说明
CertificatesU16只读变更广播证书认证证书Id
EnabledBoolean读写变更广播账户使能状态
IdU8只读变更广播账户Id
LockedBoolean只读变更广播账户锁定状态
UserNameString读写变更广播账户名
DeletableBoolean只读变更广播账户是否可以删除
PasswordChangeRequiredBoolean读写变更广播密码初始状态
PasswordExpirationU32只读变更广播密码有效期(过期时间)
RoleIdU8读写变更广播角色Id
SshPublicKeyHashString只读变更广播账户公钥hash值
AccountTypeString只读变更广播账户类型
LoginRuleIdsString[]读写变更广播登录规则集合
LastLoginTimeU32只读变更广播上次登录时间
LastLoginIPString只读变更广播上次登录IP
LastLoginInterfaceString只读变更广播上次登录接口
FirstLoginPolicyU8读写变更广播账户首次登陆口令修改策略
PrivilegesString[]只读变更广播账户拥有的实际权限
LoginInterfaceString[]读写变更广播账户可用登陆接口集合

==方法==


Delete

删除账户


ChangePwd

修改账户密码

参数

  • Password: U8[] - 待设置的密码

ChangeSnmpPwd

修改本地用户SNMP密码

参数

  • Password: U8[] - 待设置的密码

ImportSSHPublicKey

导入SSH公钥

参数

  • Type: String - Content类型:URI/Text
  • Content: String - Type为URI时,代表远程路径/本地路径;Type为Text时,代表文本内容

返回值

  • TaskId: U32 - 远程上传时代表任务Id,否则为0

DeleteSSHPublicKey

删除SSH公钥


SetLastLogin

提供给第三方认证用于记录上次登录记录

参数

  • Ip: String - 上次登录IP
  • Interface: String - 上次登录接口

返回值

  • Result: U8 - 处理结果

==自定义类型==


EnumLoginPolicy: 枚举类型

  • 0: LP_Null
  • 1: LP_PromptPasswordReset
  • 2: LP_ForcePasswordReset

RoleType: 枚举类型

  • 0: NoAccess
  • 2: CommonUser
  • 3: Operator
  • 4: Administrator
  • 5: CustomRole1
  • 6: CustomRole2
  • 7: CustomRole3
  • 8: CustomRole4
  • 9: CustomRole5
  • 10: CustomRole6
  • 11: CustomRole7
  • 12: CustomRole8
  • 13: CustomRole9
  • 14: CustomRole10
  • 15: CustomRole11
  • 16: CustomRole12
  • 17: CustomRole13
  • 18: CustomRole14
  • 19: CustomRole15
  • 20: CustomRole16

EnumAccountType: 枚举类型

  • 0: Local
  • 1: LDAP
  • 2: Kerberos
  • 3: VNC
  • 4: KVM
  • 5: KerberosSSO
  • 6: IPMI_INNER

EnumLoginInterface: 枚举类型

  • 0: Invalid
  • 1: Web
  • 2: SNMP
  • 4: IPMI
  • 8: SSH
  • 16: SFTP
  • 64: Local
  • 128: Redfish

EnumLoginRuleIds: 枚举类型

  • 0: Rule_Invalid
  • 1: Rule1
  • 2: Rule2
  • 4: Rule3

bmc.kepler.AccountService.ManagerAccount.SnmpUser

==属性==

属性名类型可读写信号通知描述
AuthenticationProtocolU8只读变更广播SNMP鉴权算法
EncryptionProtocolU8只读变更广播SNMP加密算法
SnmpEncryptionPasswordInitialStatusBoolean只读变更广播SNMP加密密码初始状态

==方法==


SetAuthenticationProtocol

设置snmp鉴权算法、鉴权密码和加密密码

参数

  • SNMPAuthenticationProtocol: U8 - SNMP鉴权算法
  • AuthPassword: String - SNMP鉴权密码
  • EncryPassword: String - SNMP加密密码

SetEncryptionProtocol

设置snmp加密算法

参数

  • SNMPEncryptionProtocol: U8 - SNMP加密算法

GetSnmpKeys

获取鉴权key和加密key

返回值

  • AuthenticationKey: String - SNMP鉴权密码 Ku
  • EncryptionKey: String - SNMP加密密码 Ku

==自定义类型==


SNMPAuthenticationProtocols: 枚举类型

  • 0: None
  • 1: MD5
  • 2: SHA96
  • 3: SHA224
  • 4: SHA256
  • 5: SHA384
  • 6: SHA512

SNMPEncryptionProtocols: 枚举类型

  • 0: None
  • 1: DES
  • 2: AES128
  • 3: AES256

SNMPKuType: 枚举类型

  • 0: Authentication
  • 1: Encryption

bmc.kepler.AccountService.ManagerAccounts

==方法==


New

新建账户;0表示不指定用户id,默认选择一个用户,不能指定id为1

参数

  • AccountId: U8
  • UserName: String
  • Password: U8[]
  • RoleId: Enum
  • LoginInterface: Array
  • FirstLoginPolicy: Enum

返回值

  • AccountId: U8

NewOEMAccount

新建OEM用户

参数

  • AccountId: U8
  • UserName: String
  • Password: String
  • ExtraData: ExtraData

返回值

  • AccountId: U8

GetIdByUserName

通过用户名获取用户id

参数

  • UserName: String

返回值

  • AccountId: U8

GetUidGidByUserName

通过用户名查找用户id,组id

参数

  • UserName: String

返回值

  • UID: U32
  • GID: U32

SetAccountWritable

设置某用户某属性是否可修改,当前定制化需求仅需支持UserName/Password

参数

  • AccountId: U8
  • PropertiesWritable: PropertyWritable

GetAccountWritable

获取某用户某属性是否可被修改

参数

  • AccountId: U8

返回值

  • PropertiesWritable: PropertyWritable

SetAccountLockState

设置用户锁定状态

参数

  • AccountId: U8
  • Lockstatus: Boolean

==自定义类型==


RoleType: 枚举类型

  • 0: NoAccess
  • 2: CommonUser
  • 3: Operator
  • 4: Administrator
  • 5: CustomRole1
  • 6: CustomRole2
  • 7: CustomRole3
  • 8: CustomRole4
  • 9: CustomRole5
  • 10: CustomRole6
  • 11: CustomRole7
  • 12: CustomRole8
  • 13: CustomRole9
  • 14: CustomRole10
  • 15: CustomRole11
  • 16: CustomRole12
  • 17: CustomRole13
  • 18: CustomRole14
  • 19: CustomRole15
  • 20: CustomRole16

LoginInterfaceType: 枚举类型

  • 0: Invalid
  • 1: Web
  • 2: SNMP
  • 4: IPMI
  • 8: SSH
  • 16: SFTP
  • 64: Local
  • 128: Redfish

FirstLoginPolicy: 枚举类型

  • 1: PromptPasswordReset
  • 2: ForcePasswordReset

PropertyWritable: 结构体类型

  • key: String
  • value: Boolean

ExtraData: 结构体类型

  • key: String
  • value: String

bmc.kepler.AccountService.PasswordPolicy

==属性==

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

bmc.kepler.AccountService.RemoteGroup

==属性==

属性名类型可读写信号通知描述
GroupTypeU8只读变更广播用户组类别
ControllerIdU8只读变更广播域控制器ID
SIDString读写变更广播SID,安全标识符,用于kerberos组认证
NameString读写变更广播用户组名
UserRoleIdU8读写变更广播用户组角色
FolderString读写变更广播组应用文件夹
PermitRuleIdsString[]读写变更广播登录规则
LoginInterfaceString[]读写变更广播组登录接口

==方法==


Delete

删除远程认证组


bmc.kepler.AccountService.RemoteGroups

==属性==

属性名类型可读写信号通知描述
AllowedLoginInterfacesString[]读写变更广播允许远程用户组开启的登录接口

==方法==


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

==属性==

属性名类型可读写信号通知描述
UserMgmtBoolean只读变更广播用户管理权限
BasicSettingBoolean只读变更广播常规设置权限
KVMMgmtBoolean只读变更广播远程控制权限
VMMMgmtBoolean只读变更广播远程媒体权限
SecurityMgmtBoolean只读变更广播安全配置权限
PowerMgmtBoolean只读变更广播电源控制权限
DiagnoseMgmtBoolean只读变更广播调试诊断权限
ReadOnlyBoolean只读变更广播查询功能权限
ConfigureSelfBoolean只读变更广播配置自身权限

==自定义类型==


PrivilegeType: 枚举类型

  • 0: UserMgmt
  • 1: BasicSetting
  • 2: KVMMgmt
  • 3: VMMMgmt
  • 4: SecurityMgmt
  • 5: PowerMgmt
  • 6: DiagnoseMgmt
  • 7: ReadOnly
  • 8: ConfigureSelf

bmc.kepler.AccountService.Role

==属性==

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

==方法==


SetRolePrivilege

设置角色权限

参数

  • PrivilegeType: U8
  • PrivilegeValue: Boolean

Delete

删除角色


bmc.kepler.AccountService.Roles

==属性==

属性名类型可读写信号通知描述
ExtendedCustomRoleEnabledBoolean读写变更广播增加自定义用户角色功能使能开关

==方法==


New

新增角色

参数

  • RoleId: U8 - 角色Id
  • AssignedPrivileges: String[] - 角色标准权限
  • OemPrivileges: String[] - 角色Oem权限

bmc.kepler.AccountService.Rule

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播登录规则使能状态
IpRuleString读写变更广播IP登录规则
MacRuleString读写变更广播MAC地址登录规则
TimeRuleString读写变更广播时间登录规则

bmc.kepler.Assembly

==属性==

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

bmc.kepler.AssetService.AssetChange

==方法==


UpdateTrustStatus

刷新可信资产基准信息


GetTrustRecord

获取资产可信状态

返回值

  • List: String - 获取全量的可信资产变更记录,json格式输出

bmc.kepler.AssetService.AssetList

==方法==


GetAssetList

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

返回值

  • List: String - 硬件资产清单的json字符串

GetSpecificAssetList

获取指定的资产信息的json字符串

参数

  • SystemId: U8 - 系统Id, 当取值255时,代表获取所有System的资产清单
  • AssetType: String - 指定获取资产类型,当取值空串时,代表获取所有当前支持的资产类型信息
  • AssetProperties: String[] - 指定获取资产属性,当取值空数组时,代表获取所有当前支持的属性信息

返回值

  • List: String - 指定硬件资产清单的json字符串

bmc.kepler.AssetService.TrustedSupplyChain

==属性==

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

==方法==


GetChangedEvents

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

返回值

  • List: String - 供应链配置检查产生变更的配置详情json字符串

ConfirmChangedEvents

关闭供应链配置检查,清除告警


bmc.kepler.Bus

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
JlcTckRateU8只读变更广播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

==属性==

属性名类型可读写信号通知描述
CertOverdueWarnDaysU32读写变更广播证书过期提前告警时间(单位:天)
CRLOverdueWarnModeString读写变更广播吊销列表过期提前告警模式
CRLOverdueWarnDaysU32读写变更广播吊销列表过期提前告警时间(单位:天)
CRLEnabledBoolean读写变更广播证书吊销列表检查使能
IsDefaultSSLCertBoolean只读变更广播是否预置的SSL证书
SSLCertAlgorithmU8读写变更广播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

GenerateCSR

开始生成CSR任务

参数

  • Country: String - 国家
  • State: String - 州、省份
  • Location: String - 城市
  • OrgName: String - 公司
  • OrgUnit: String - 部门
  • CommonName: String - 常用名
  • AlternativeNames: String[] - 使用者可选名称
  • KeyUsage: String[] - CSR中描述证书密钥用途
  • KeyBitLength: S32 - CSR对应证书密钥长度
  • Options: CSRProperty - CSR生成的可选配置

返回值

  • FilePath: String - 文件预期生成的路径,在任务完成后,会在该路径生成csr文件
  • TaskId: U32
  • CSRString: String - CSR文件内容

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: 枚举类型

  • 0: PEM
  • 1: PEMchain
  • 2: PKCS7

KeyUsage: 枚举类型

  • 0: DigitalSignature
  • 1: NonRepudiation
  • 2: KeyEncipherment
  • 3: DataEncipherment
  • 4: KeyAgreement
  • 5: KeyCertSign
  • 6: CRLSigning
  • 7: EncipherOnly
  • 8: DecipherOnly
  • 9: ServerAuthentication
  • 10: ClientAuthentication
  • 11: CodeSigning
  • 12: EmailProtection
  • 13: Timestamping
  • 14: OCSPSigning

CertificateUsageType: 枚举类型

  • 0: ManagerCACertificate
  • 1: ManagerSSLCertificate
  • 2: ManagerAccountCertificate
  • 3: ManagerCMPCertificate

CertAlgorithm: 枚举类型

  • 0: RSA
  • 1: ECC
  • 2: SM2

CertInChainType: 枚举类型

  • 0: Root
  • 1: Intermediate
  • 2: Last

CertTaskStatus: 枚举类型

  • 1: NotStart
  • 2: Running
  • 3: Failed
  • 4: Success

CSRProperty: 结构体类型

  • key: String - CSR 参数,Country、State等
  • value: String - 对应CSR参数的值

bmc.kepler.CertificateService.CA

==属性==

属性名类型可读写信号通知描述
PrivilegeU32读写变更广播CA operate privilege,bit0 indicates whether it can be deleted
RedfishSchemaVersionString读写变更广播Redfish Certificate CA资源的Schema版本

bmc.kepler.CertificateService.Certificate

==属性==

属性名类型可读写信号通知描述
CertificateTypeU32只读变更广播SecurityEnum.CertificateType, NoUse
CertificateUsageTypeU32只读变更广播SecurityEnum.CertificateUsageType
FingerprintString只读变更广播资源路径
FingerprintHashAlgorithmString只读变更广播默认SHA256
IssuerString只读变更广播颁发者,签发者
KeyUsageU32[]只读变更广播SecurityEnum.KeyUsage
SerialNumberString只读变更广播序列号
SignatureAlgorithmString只读变更广播签名算法
SubjectString只读变更广播颁发给,使用者
ValidNotAfterString只读变更广播The date when the certificate is no longer valid.
ValidNotBeforeString只读变更广播The date when the certificate becomes valid.
FilePathString只读变更广播文件路径
CommonNameString只读变更广播证书名,使用者CN字段
CRLStartTimeString只读变更广播吊销列表有效期开始时间
CRLExpireTimeString只读变更广播吊销列表有效期结束时间
CertCountU32只读变更广播证书链中证书个数,如果是单个证书大小为1
KeyLengthU32只读变更广播秘钥长度

==方法==


DeleteCRL

删除对应证书的吊销列表,必须存在对应的吊销列表


==自定义类型==


CertificateUsageType: 枚举类型

  • 0: ManagerCACertificate
  • 1: ManagerSSLCertificate
  • 2: ManagerAccountCertificate
  • 3: ManagerCMPCertificate

bmc.kepler.CertificateService.Certificate.Account

==属性==

属性名类型可读写信号通知描述
RootCertUploadedStateBoolean只读变更广播It indicates whether the issuer uploaded
IssuerIdU32只读变更广播Issuer cert id
RevokedStateBoolean只读变更广播It Indicates whether the cert is revoked
RevokedDateString只读变更广播The date the cert was revoked

bmc.kepler.CertificateService.Certificate.CA

==属性==

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

==方法==


DeleteCRL

删除对应证书的吊销列表,必须存在对应的吊销列表


ImportCRL

参数

  • Type: String - 文件导入类型,可以是text或URI。text表示文本内容导入,Content字段为证书内容,URI表示文件导入,可以是本地或者远程文件
  • Content: String - 证书文本内容或者文件路径,和Type配合,指定文件

bmc.kepler.CertificateService.Certificate.Entity

==属性==

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

bmc.kepler.CertificateService.CertificateLocation

==属性==

属性名类型可读写信号通知描述
PathsString[]只读变更广播所有证书资源路径集合

bmc.kepler.CertificateService.Renew

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播证书自动更新使能状态
AuthTypeU8读写变更广播CA服务器认证方式,1代表单向认证,2代表双向认证
AddressString读写变更广播CA服务器地址
PortU16读写变更广播CA服务器端口
CMPPathString读写变更广播CA服务器CMP路径

==方法==


Renew

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


bmc.kepler.CertificateService.Renew.Subject

==属性==

属性名类型可读写信号通知描述
CountryString读写变更广播国家
StateString读写变更广播州、省份
LocationString读写变更广播城市
OrgNameString读写变更广播公司
OrgUnitString读写变更广播部门
CommonNameString读写变更广播常用名
InternalNameString读写变更广播内部名
EmailString读写变更广播邮箱
AlternativeNamesString[]读写变更广播使用者可选名称

bmc.kepler.Chassis

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播机框名
IntrusionFlagU8只读变更广播开箱事件标志 开箱:0x01 关闭:0x0
UidButtonPressedU8只读变更广播UID按钮按下标志
UidButtonLongPressedU8只读变更广播UID按钮长按标志
ChassisTypeU8只读变更广播当前管理软件类型
LocationString读写变更广播位置信息
DeviceSpecicationArray只读变更广播设备最大数量集合
TopologyConfigIdU16只读变更广播产品组网拓扑

==自定义类型==


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

==属性==

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

bmc.kepler.Chassis.Enclosure

==属性==

属性名类型可读写信号通知描述
CabinetSerialNumberString只读变更广播机柜sn
EnclosureSerialNumberString只读变更广播机框sn

bmc.kepler.Chassis.EnergySavingMeasurement

==属性==

属性名类型可读写信号通知描述
RevenueStartTimeU32只读变更广播收益度量起始时间(时间戳)
RecommendedPowerModeString只读变更广播推荐的电源工作模式
RecommendedActivePowerSuppliesU8[]只读变更广播推荐的主用电源列表

==方法==


GetPolicyGuidances

获取节能策略指导

返回值

  • PolicyGuidanceData: Array - 节能策略指导数据

==自定义类型==


PolicyGuidance: 结构体类型

  • Component: String - 部件名
  • HealthPercent: U8 - 系统功率
  • CurrentPolicies: String[] - 当前策略
  • RecommendedPolicies: String[] - 推荐策略
  • Influence: String[] - 影响

bmc.kepler.Chassis.EnergySavingScene

==属性==

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

==方法==


GetModeByScene

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

参数

  • Scene: String - 根据查询的智能节能场景对应节能系统的配置值

返回值

  • Systems: System - 获取节能系统的模式以及各个模式下的对应的值

==自定义类型==


System: 结构体类型

  • key: String
  • value: Parameters - 节能系统

Parameters: 结构体类型

  • key: String
  • value: String

bmc.kepler.Chassis.FanGroup

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播风扇组Id
FanSlotsU8[]只读变更广播风扇组内槽位号
SpeedPercentDouble只读变更广播基于风扇组内风扇修正后的转速,并统一下发至所有风扇
ExpectedSpeedPercentDouble读写变更广播风扇组分组下发转速

bmc.kepler.Chassis.FruCtrl

==属性==

属性名类型可读写信号通知描述
PowerStateString只读变更广播整刀片上下电状态
PowerOnStrategyString读写变更广播整刀片通电开机策略
PreviousPowerStateString只读变更广播记录启动之前的整机上下电状态,用于通电开机策略为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

==属性==

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

==方法==


SetLeakPolicy

设置漏液后的应对策略

参数

  • LeakValvePolicy: U8 - 漏液关断阀策略,0:不操作,1:自动关断,255:保持当前值
  • LeakPowerPolicy: U8 - 漏液下电策略,0:不操作,1:自动下电,255:保持当前值

bmc.kepler.Chassis.LeakDetection.LeakDetector

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播漏液检测点ID
NameString只读变更广播漏液检测点名称
EnabledBoolean读写变更广播是否使能漏液检测点,false:不使能,true:使能
StateU8只读变更广播漏液状态,0:无漏液,1:轻微漏液(Warning),2:严重漏液(Critical)
HealthU8只读变更广播漏液传感器状态,0:无漏液,1:有漏液

bmc.kepler.Chassis.PCIeSwitch

==属性==

属性名类型可读写信号通知描述
UpgradeStatusU8只读变更广播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

==属性==

属性名类型可读写信号通知描述
UpgradeStatusU8只读变更广播电源升级状态。0表示不在升级状态;1表示在升级前准备;2表示升级准备完成,开始升级。

==方法==


SetPsusFanMinPWM

设置所有psu风扇最低转速(如果设置的最低转速高于电源风扇控制的转速时才生效)

参数

  • FanMinPWM: U8 - 所有psu风扇的转速百分比

bmc.kepler.Chassis.PumpGroup

==属性==

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

bmc.kepler.Chassis.SensorSelInfo

==属性==

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

bmc.kepler.Chassis.Sensors

==属性==

属性名类型可读写信号通知描述
HealthString只读变更广播系统健康状态,取值有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

==属性==

属性名类型可读写信号通知描述
SuperPodIdU32只读变更广播超节点集合Id,默认值4294967295
ServerIndexU16只读变更广播超节点内的计算节点Id编号,默认值65535
SuperPodSizeU16只读变更广播超节点规模(npu卡的数),默认值384
SuperPodEnabledBoolean读写变更广播是否是超节点模式,未配置默认为false

==方法==


SetSuperPodId

设置超节点ID

参数

  • SuperPodId: U32 - 超节点ID

返回值

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

SetServerIndex

设置超节点服务器编号

参数

  • ServerIndex: U16 - 服务器编号

返回值

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

SetSuperPodSize

设置超节点容量

参数

  • SuperPodSize: U16 - 超节点容量

返回值

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

RestoreDefaults

恢复超节点属性默认值

返回值

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

bmc.kepler.Chassis.ThermalSubsystem.Metrics

==属性==

属性名类型可读写信号通知描述
TotalPowerWattsU32只读变更广播散热器件总功耗
EnergyConsumptionkWhDouble读写变更广播散热器件累计耗电量
ResetTimeU32只读变更广播散热器件累计耗电量开始统计时间

==方法==


ResetMetrics

散热器件累计耗电量信息重新统计


bmc.kepler.Chassis.Valve

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播关断阀Id
SlotU8只读变更广播关断阀槽位
PresenceU8只读变更广播关断阀在位。1在位,0不在位
OpeningDegreeU32读写变更广播关断阀开度
StandardOpeningDegreeU32只读变更广播关断阀标称开度
StatusU16只读变更广播关断阀故障状态: 0-正常, 非0-关断阀故障
OpeningDegreeStateU8只读变更广播关断阀开度状态:0-正常, 1-异常
PatrolResultU8只读变更广播关断阀巡检结果: 0-成功, 1-失败

bmc.kepler.Chassis.Valves

==属性==

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

==方法==


StartPatrol

启动关断阀巡检

参数

  • DelaySeconds: U32 - 巡检开始等待时间(秒)

bmc.kepler.Chip

==属性==

属性名类型可读写信号通知描述
HealthStatusU8只读变更广播硬件的健康状态
PowerStatusU8只读变更广播硬件的上电状态
SelfTestResultU8只读变更广播硬件的自检结果
LockStatusU8只读变更广播硬件通道锁定状态,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: 枚举类型

  • 0: OK
  • 1: InvalidParameter
  • 2: UnlockedError
  • 3: RequestorMismatchedError
  • 4: ChipMismatchedError
  • 5: ChannelMismatchedError

bmc.kepler.Chip.Aggregate

==属性==

属性名类型可读写信号通知描述
SupportedBoolean只读变更广播Chip是否具备汇聚数据访问能力, true: 具备能力, false: 默认值, 不具备能力
BaseOffsetU32只读变更广播汇聚资源起始偏移/汇聚命令字, Smc场景下为汇聚命令字; 其他块设备场景为起始偏移, 连续读取一段数据
LengthU32只读变更广播汇聚资源总长度
PeriodU32只读变更广播汇聚资源扫描间隔(单位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

==属性==

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

bmc.kepler.CmdInfo

==属性==

属性名类型可读写信号通知描述
FilterString只读变更广播用于匹配IPMI命令数据,生成路由表
PrivilegeS16只读变更广播IPMI命令的访问权限
PriorityS16只读变更广播命令优先级,当存在相同命令时,选择优先级高的执行
CmdU8只读变更广播IPMI命令字
ServiceNameString只读变更广播命令对应的服务名
NetFnU8只读变更广播IPMI网络字节功能码
SysLockedPolicyString只读变更广播系统锁定属性
SensitiveBoolean只读变更广播ipmi命令是否包含敏感信息

==方法==


Process

处理IPMI请求,并返回响应

参数

  • Data: U8[] - 请求数据
  • Context: U8[] - 请求上下文的json字符串,包括通道类型、会话信息、客户端信息

返回值

  • Response: U8[] - 响应数据

bmc.kepler.Connector

==属性==

属性名类型可读写信号通知描述
BomString只读变更广播Bom号
SlotU8读写变更广播信号槽
GroupIdU32只读变更广播对象组ID
GroupPositionString只读变更广播对象组位置
PresenceU8读写变更广播Connector的在位状态
IdString读写变更广播Connector的ID
AuxIdString读写变更广播Connector的AuxID
BusesString[]只读变更广播Connector的总线
SystemIdU8只读变更广播Connector的SystemId
ManagerIdString只读变更广播Connector的ManagerId
SilkTextString只读变更广播
TypeString只读变更广播Connector的类型
IdentifyModeU8只读变更广播Connector的标志模式
ChassisIdString只读变更广播Connector的ChassisId
LoadStatusU8只读变更广播Connector的加载状态

==方法==


Reload

重新加载连接器

参数

  • Bom: String - 连接器的Bom
  • Id: String - 连接器的Id
  • AuxId: String - 连接器的AuxId
  • IdentifyMode: U8 - 连接器的加载方式

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

==方法==


SetPeriod

设置节能专家推荐系统计算周期

参数

  • Period: U32 - 计算周期时间,单位为秒,最小时间为60s,最大时间为86400s(24小时)

bmc.kepler.Debug.IpmiCore.TraceIpmi

==属性==

属性名类型可读写信号通知描述
EnableTraceBoolean只读变更广播跟踪IPMI命令收发状态的使能开关
ChannelString只读变更广播协议通道,支持bt,ipmb,ipmbeth,edma通道
NetfnU8只读变更广播网络功能码
CmdU8只读变更广播命令字
FilterString只读变更广播预留字段,用于过滤命令
LogTypeString只读变更广播日志类型,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

==属性==

属性名类型可读写信号通知描述
LifeTimeU8只读变更广播调试模式下flash使用的寿命,百分比
PreEOLU8只读变更广播调试模式下预留块状态
DelayTimeU32只读变更广播调试模式下计算使用寿命及使用块的间隔时间,单位秒
TimeIntervalU32只读变更广播调试模式下写入量统计时间间隔,单位秒
WriteThresholdU64只读变更广播调试模式下写入量的阈值,单位字节
ClearStatisticsIntervalU32只读变更广播调试模式下重置写入量的时间间隔,单位秒
EnabledBoolean读写变更广播开启关闭调试模式
SamplingPeriodSecondsU32读写变更广播扫描周期,单位秒

==方法==


SetDebugValue

调试模式下设置参数

参数

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

bmc.kepler.Debug.Managers.SecureBoot

==方法==


GetSecureBootConfiguration

查询安全启动相关信息

参数

  • Subcmd: S32 - 查询的内容类型,当前仅支持0,表示查询BMC根文件系统签名CA的摘要值
  • Args: String - Subcmd的执行参数,当Subcmd取值0时,该字段仅支持取值pss或者pkcs

返回值

  • Configuration: String - 查询的安全启动的信息,当Subcmd为0时,返回样例["RootfsCADigest":"xxx"]

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

==属性==

属性名类型可读写信号通知描述
PerformanceSamplingIntervalMinutesU16读写变更广播性能数据采集周期,单位:分钟

bmc.kepler.Debug.Performance.Metrics

==属性==

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

==方法==


Report

导出性能报表数据(导出到/tmp目录下)


bmc.kepler.Debug.PidConfiguration

==方法==


GetVersion

打印PID版本信息


SetPidPrintMode

设置PID信息打印开关

参数

  • Type: U8 - PID信息类型,1表示配置信息,2表示控制信息
  • Enabled: U8 - PID信息打印开关,取值为0和1, 0表示关闭信息打印,1表示开启信息打印

SetPidConfigItem

设置PID模块配置信息

参数

  • ItemIndex: U8 - PID场景识别配置项索引
  • ItemValue: U8 - 配置场景值

bmc.kepler.Debug.PowerCapping

==方法==


SimulatePowerCappingTask

通过模拟整机功耗值进行功耗封顶

参数

  • Mode: U8 - 是否开启整机功耗调试模式,取值0和1,0表示关闭,1表示开启
  • Ratio: Double - 功耗封顶值比例范围[0.1, 1.0],该参数为可选参数

SimulatePowerCappingConfig

设置功耗封顶下限值,以及模拟上报功耗封顶失败事件请求

参数

  • Type: U8 - 调试类型,0表示模拟功耗封顶下限值,1表示模拟上报功耗封顶失败事件
  • Value: U32 - 功耗封顶下限值,该参数为可选参数

bmc.kepler.Debug.RemoteAccess.CAN

==方法==


SendTestBoardcast

发送测试广播

参数

  • Channel: U8 - 发送测试广播的CANBUS编号

PrintMetrics

打印CANBUS统计信息

参数

  • Channel: U8 - 参与统计的CANBUS编号,默认为0xFF(打印所有的CANBUS统计信息)

返回值

  • Details: Array - CANBUS的统计详细信息集合

==自定义类型==


DetailItem: 结构体类型

  • Item: String - 每个CANBUS的统计详细信息,采用 json 格式编码

bmc.kepler.Debug.Storage.PhyBitError

==属性==

属性名类型可读写信号通知描述
FileMockEnabledBoolean读写变更广播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

==属性==

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

bmc.kepler.EventService

==属性==

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

==方法==


SubmitTestEvent

模拟测试事件方法

参数

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

Rearm

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


bmc.kepler.EventService.Event

==属性==

属性名类型可读写信号通知描述
RecordIdU64只读变更广播表示bmc启动前已上报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

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播订阅者资源Id
DestinationString只读变更广播事件订阅接收地址
EventTypesString[]只读变更广播事件订阅侦听的事件类型
MessageIdsString[]只读变更广播事件订阅消息Id匹配列表
OriginResourcesString只读变更广播事件订阅事件源匹配列表
ContextString读写变更广播事件订阅上下文信息
ProtocolString只读变更广播事件订阅使用的协议,当前取值只能为Redfish
SendHeartbeatBoolean只读变更广播告警心跳使能
HeartbeatIntervalMinutesU16只读变更广播告警心跳间隔,取值范围[1:65535]
MetricReportDefinitionsString[]只读变更广播指定事件订阅上报的Metric Report列表
StateString读写变更广播redfish上报的订阅状态,Enabled表示上报事件;Disabled表示不上报事件,但是会缓存事件
DeliveryRetryPolicyString读写变更广播redfish上报的重试策略,如果用户空字符串,则认为指定了默认值

==方法==


SetHttpHeaders

设置http请求头(加密存储)

参数

  • Headers: String - http请求头

Delete

删除时间订阅资源


ResumeSubscription

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

参数

  • DeliverBufferedEventDuration: String - 指定恢复的事件,若不为空则需要符合ISO-9601规范的字符串

返回值

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

SuspendSubscription

暂停redfish事件消息发送


bmc.kepler.EventService.Subscriptions.Redfish

==属性==

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

bmc.kepler.EventService.Subscriptions.Smtp

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播SMTP上报事件是否使能
AddressString读写变更广播SMTP服务器的地址
PortU16读写变更广播SMTP服务器端口号
TLSEnabledBoolean读写变更广播TLS加密是否使能
ServerAuthEnabledBoolean读写变更广播SMTP服务器的身份认证是否使能(单向认证是否使能)
SeverityFilterU8读写变更广播告警上报的级别,只有对应Bit位为1的级别才会上报
EventTypeString读写变更广播用于Smtp通道事件上报的类型

==方法==


SetAddress

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

参数

  • Address: String - SMTP服务器地址
  • PasswordChanged: Boolean - 用户是否重置密码

bmc.kepler.EventService.Subscriptions.Smtp.Email

==属性==

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

==方法==


SetAnonymousState

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

参数

  • State: Boolean - 匿名使能状态
  • PasswordChanged: Boolean - 用户是否重置密码

bmc.kepler.EventService.Subscriptions.Smtp.Receiver

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播告警收件人是否使能
ToAddressString读写变更广播告警收件人的邮箱地址
DescriptionString读写变更广播告警收件人的描述信息

==方法==


SubmitTestEvent

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


bmc.kepler.EventService.Subscriptions.Smtp.Sender

==属性==

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

==方法==


SetUsername

设置发件人的用户名,非匿名时需要重置发件人密码

参数

  • Username: String - 发件人的用户名
  • PasswordChanged: Boolean - 用户是否重置密码

SetPassword

设置发件人用户密码

参数

  • Password: String - 发件人用户密码

bmc.kepler.EventService.Subscriptions.Snmp

==属性==

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

==方法==


SetCommunity

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

参数

  • Community: String - SNMP上报告警事件的团体名

GetCommunity

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

返回值

  • Community: String - SNMP trap v1v2上报告警事件的团体名

bmc.kepler.EventService.Subscriptions.Snmp.Nms

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播网络管理系统是否使能
BobEnabledBoolean读写变更广播转发到带内BMA是否使能
AddressString读写变更广播网络管理系统的地址
PortU16读写变更广播网络管理系统的端口号

==方法==


SubmitTestEvent

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


bmc.kepler.EventService.Subscriptions.Syslog

==属性==

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

bmc.kepler.Example.InterfaceBar

==属性==

属性名类型可读写信号通知描述
IdU32只读变更广播接口ID
NameString只读变更广播接口名称
PresenceBoolean读写变更广播接口在位状态
FrudataU8[]读写变更广播fru数据

==方法==


MethodBar

参数

  • StructArg: unknown
  • ArrayArg: U32[]
  • ArrayStruct: Array

返回值

  • Result: U32

==自定义类型==


SturctArg: 结构体类型

  • SubArg1: String
  • SubArg2: String

bmc.kepler.Example.InterfaceFoo

==属性==

属性名类型可读写信号通知描述
NameString读写变更广播接口名称
StatusU32只读变更广播接口在位状态

==方法==


MethodFoo

参数

  • Arg1: U32

返回值

  • Result: U32

bmc.kepler.Example.InterfaceTest

==属性==

属性名类型可读写信号通知描述
IdU32只读变更广播接口id
NameString读写变更广播接口名称
PresenceBoolean读写变更广播接口在位状态
FrudataU8[]读写变更广播接口fru数据
StructStruct读写变更广播接口在位状态
PropADict1读写变更广播接口属性

==方法==


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

==属性==

属性名类型可读写信号通知描述
AssetTypeString只读变更广播硬件资产类型
AssetNameString只读变更广播硬件资产名称
SerialNumberString只读变更广播硬件资产序列号
FirmwareVersionString只读变更广播硬件资产固件版本
PCBVersionString只读变更广播硬件资产PCB版本
ManufacturerString只读变更广播硬件资产制造商
AssetTagString只读变更广播硬件资产标签
PartNumberString只读变更广播硬件资产部件编号
ManufactureDateString只读变更广播硬件资产生产日期
SlotString只读变更广播硬件槽位号
UUIDString只读变更广播硬件UUID号
ModelString只读变更广播硬件资产型号

bmc.kepler.IpmiCore

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
ModeU8读写变更广播防火墙黑白名单模式,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.IpmiService.MasterWriteRead

==属性==

属性名类型可读写信号通知描述
BusSwitchEnabledBoolean读写变更广播BusId启用是否超过8使能,false:disable,true:enable

bmc.kepler.JobService

==属性==

属性名类型可读写信号通知描述
DateTimeString只读变更广播JobService服务状态变更时间
MaxJobsU32只读变更广播JobService服务支持的最大job数
SchedulingBoolean只读变更广播JobService服务是否支持任务编排
ServiceEnabledBoolean读写变更广播JobService服务使能状态
DeleteOnCompletionTimeoutMinutesU32只读变更广播JobService服务已完成状态job的清理时间

==方法==


GetJobTypes

获取已支持的Job任务信息

返回值

  • Data: String[] - 已支持的Job任务信息

bmc.kepler.JobService.Job

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播Job任务的Id
CreatedByString只读变更广播Job任务的创建者
JobStatusString只读变更广播Job功能本身的状态
JobStateString只读变更广播Job任务的状态
StartTimeU32只读变更广播Job任务开始时间戳
EndTimeU32只读变更广播Job任务结束时间戳
PercentCompleteU32只读变更广播Job任务的状态
LifetimeString只读变更广播Job任务整体过期时间
InitialStartTimeU32只读变更广播Job任务最早触发时间戳
RecurrenceIntervalString只读变更广播最近两次连续执行任务的时间间隔
EnabledDaysOfWeekString[]只读变更广播每周的哪一天生效
MaxOccurrencesU32只读变更广播最大的执行次数
NameString只读变更广播Job任务的名称
HidePayloadBoolean只读变更广播是否隐藏payload的显示
JsonBodyString只读变更广播Job任务执行的参数
JobTypeString只读变更广播Job任务的类型
CreateTimeU32只读变更广播Job任务的创建时间戳
ExecutedTimesU32只读变更广播Job任务执行的次数
OriginString只读变更广播创建任务的接口来源
AbortableBoolean只读变更广播Job任务是否可以终止
MessageArgsString[]只读变更广播消息涉及的参数
MessageIdString只读变更广播消息的ID
MessageString只读变更广播消息的内容

==方法==


DeleteJob

删除Job


UpdateJob

更新Job

参数

  • Request: JobObject - Job信息键值表,键的值包括:JobState、EnabledDaysOfWeek、InitialStartTime、Lifetime、MaxOccurrences、Name、RecurrenceInterval

==自定义类型==


JobObject: 结构体类型

  • key: String
  • value: String

bmc.kepler.JobService.JobFunction

==属性==

属性名类型可读写信号通知描述
JobTypeString只读变更广播注册到JobService的Job的类型
MaxExecutionTimeU32只读变更广播Job允许的最大执行时间,单位:min
PayloadParamsString只读变更广播Job执行Run动作需要的入参schema
PrivilegeString[]只读变更广播操作Job需要的权限
LockdownAllowBoolean只读变更广播用于系统锁定打开状态下操作是否允许运行Job,值为true代表操作允许,值为false表示不允许
AbortableBoolean只读变更广播是否支持运行时终止任务,值为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

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
DomainIdU32只读变更广播域ID
KeyIdU32只读变更广播keyID
KeyTypeU32只读变更广播key的类型
StatusU32只读变更广播key的状态
GenerateTypeU32只读变更广播key的生成状态
CreateTimeU32只读变更广播key的创建时间
ExpiredTimeU32只读变更广播key的过期时间
CiphertextKeyIdU32只读变更广播密文的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.LCN

==属性==

属性名类型可读写信号通知描述
SerialNumberString只读变更广播交换系统的序列号
SlotNumberU8只读变更广播交换系统的槽位号
DescriptionString只读变更广播交换系统的设备描述
ProductNameString只读变更广播交换系统的部件名称
PartNumberString只读变更广播交换系统的部件编码
ManufacturerString只读变更广播交换系统的生产厂商
PresenceU8只读变更广播交换系统的在位情况
MemorySizeMiBU32只读变更广播交换系统的内存大小
FlashSizeMiBU32只读变更广播交换系统的Flash大小
PowerStateU8只读变更广播交换系统的上下电状态

bmc.kepler.LCN.Card

==属性==

属性名类型可读写信号通知描述
SlotNumberU8只读变更广播交换系统子卡的槽位号
ProductNameString只读变更广播交换系统子卡的型号
PCBVersionString只读变更广播交换系统子卡的PCB版本
LogicDevicesLogicVerObject只读变更广播交换系统子卡的所有逻辑版本号
PresenceU8只读变更广播交换系统子卡的在位情况

==自定义类型==


LogicVerObject: 结构体类型

  • key: String - 逻辑器件名
  • value: String - 逻辑器件版本号

bmc.kepler.LCN.Manage

==属性==

属性名类型可读写信号通知描述
ManagedByBMCBoolean读写变更广播交换系统被BMC纳管的使能状态
EventRecieveEnabledBoolean读写变更广播交换告警是否上报BMC
BMCEthIdU8只读变更广播与交换系统通信的BMC网口Id

==方法==


ExportLog

导出日志

参数

  • Path: String - 导出日志的路径

返回值

  • TaskId: U32 - 任务ID

bmc.kepler.LCN.NetworkConfig

==属性==

属性名类型可读写信号通知描述
InterfaceString只读变更广播网络接口名称, 如METH0/0/0
VPNString只读变更广播网络接口绑定的VPN实例, 通过1260命令行查询
IPAddressString只读变更广播网络接口IP地址, 通过1260命令行查询

==方法==


SetInterfaceConfig

设置网络配置

参数

  • Policy: U8 - 修改策略, 0(只修改本地) 1(本地+1260), 仅GE3口支持修改本地
  • Parameters: ParameterList - 设置可选参数 key: 参数名, value: 设置值

==自定义类型==


ParameterList: 结构体类型

  • key: String - 参数名
  • value: String - 设置值

bmc.kepler.LCN.Version

==属性==

属性名类型可读写信号通知描述
PatchVersionString只读变更广播交换系统的补丁版本号
SoftwareVersionString只读变更广播交换系统的系统软件版本号
PCBVersionString只读变更广播交换系统的PCB版本号
MABVersionString只读变更广播交换系统的制成板(Manufacture Board)版本号
LogicDevicesLogicVerObject只读变更广播交换系统的所有逻辑版本号
BiosVersionString只读变更广播交换系统的BIOS版本号

==自定义类型==


LogicVerObject: 结构体类型

  • key: String - 逻辑器件名
  • value: String - 逻辑器件版本号

bmc.kepler.LicenseService

==属性==

属性名类型可读写信号通知描述
ESNString只读变更广播设备序列号,由主板的序列号生成,用于web页面或redfish返回消息中信息呈现
CapabilityString[]只读变更广播表示License组件是否具备本地管理和远程管理的能力,取值为Remote, Local
ESNStateString只读变更广播产品ESN是否有效,主板序列号和ESN对应时认为ESN有效
FileStateString只读变更广播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

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播授权特性名称
StatusBoolean只读变更广播授权特性使能状态

bmc.kepler.LicenseService.License

==属性==

属性名类型可读写信号通知描述
StatusString只读变更广播当前License的状态
RevokeTicketString只读变更广播当前License失效后的失效码
RemainGraceDaysU32只读变更广播当前License剩余的宽限期天数
RemainCommissioningDaysU32只读变更广播当前License剩下的调测天数

==方法==


GetContent

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

返回值

  • Content: String - License信息

bmc.kepler.LifeCycle.Retirement

==属性==

属性名类型可读写信号通知描述
MediaString只读变更广播数据存储介质
SourceString只读变更广播存储介质来源
DescriptionString只读变更广播数据清理描述
MethodString只读变更广播数据清除方法
ResultString只读变更广播部件数据销毁结果
ProgressU8只读变更广播部件数据销毁进度
StateString只读变更广播部件数据销毁状态

==方法==


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

==属性==

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

bmc.kepler.Managers.BlackBox

==方法==


DumpData

黑匣子数据下载接口

参数

  • Path: String - 导出路径

返回值

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

bmc.kepler.Managers.Chassis.NetConfig

==属性==

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

bmc.kepler.Managers.Configurations

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
EthNameString只读变更广播网口名称
NetModeString读写变更广播网络模式
MacString只读变更广播网口Mac地址
IpVersionString读写变更广播IP协议类型,IPv4,IPv6,IPv4AndIPv6
NcsiEnableBoolean只读变更广播NCSI使能状态
PortIdU8只读变更广播当前激活端口
VLANEnableBoolean只读变更广播NCSI VLAN使能状态
VLANIdU16只读变更广播Vlan Id
MinVLANIdU16只读变更广播VLAN取值范围下限值
MaxVLANIdU16只读变更广播VLAN取值范围上限值
SLAACAddressListString[]只读变更广播SLAAC地址
LinkLocalAddressString只读变更广播ipv6本地链路地址
BackupIpActivatedBoolean只读变更广播备份ip激活状态
DefaultFactoryIpModeString只读变更广播出厂默认IPv4模式
DefaultFactoryIpAddrString只读变更广播出厂默认IPv4地址
DefaultFactoryIpv6ModeString只读变更广播出厂默认IPv6模式
DefaultFactoryIpv6AddrString只读变更广播出厂默认IPv6地址
DefaultFactoryIpVersionString只读变更广播出厂默认网络模式

==方法==


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

==属性==

属性名类型可读写信号通知描述
PrimaryNameServerString读写变更广播主选域名服务器地址
BackupNameServerString读写变更广播备选域名服务器地址1
TertiaryNameServerString读写变更广播备选域名服务器地址2
DHCPv4UseDNSServersBoolean读写变更广播是否通过DHCPv4服务器来获取DNS服务器地址
DHCPv6UseDNSServersBoolean读写变更广播是否通过DHCPv6服务器来获取DNS服务器地址
ServerIpVersionString读写变更广播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

==属性==

属性名类型可读写信号通知描述
GroupIdU8只读变更广播网口组ID
NameString只读变更广播网口组名
OutTypeU8只读变更广播网口组的类型:1:对内,2:对外,3:veth,4:计算节点近端维护内部网络,5:计算节点近端维护外出网络,6:SMM板浮动IP网络,7:SMM板出对板的内部网络,8:专用网口近端运维网络,9:机柜管理板内网,10: 机柜节点内网
ActiveEthIdU8只读变更广播当前激活的网口号,例如eth2的话此处网口号为2
InnerNetWorkString只读变更广播内网网段
VLANIdU16只读变更广播VLANId,0表示VLAN关闭,反之为开启,范围为1-4094
VLANEnabledBoolean只读变更广播VLAN使能状态
EthAliasU8只读变更广播激活网口别名,有别名时取值最大为254,255表示没有别名网口
IpAddrString只读变更广播IPv4地址
BaseIpAddrString只读变更广播基准IPv4地址,和IpAdd作比较,判断是否根据槽位号生成过Ip
SubnetMaskString只读变更广播子网掩码
DefaultGatewayString只读变更广播IPv4网关
IpPolicyU8只读变更广播ip生成策略:0:根据默认IP地址,1:根据槽位和基准IP地址生成
StatusBoolean只读变更广播该IP是否在工作状态中
IpModeString读写变更广播IPv4模式(DHCP/Static),默认配置Static
BackupIpAddrString读写变更广播备份IPv4地址
BackupSubnetMaskString读写变更广播备份IPv4子网掩码
Ipv6ModeString读写变更广播DHCPv6:自动获取,Static:手动配置,默认配置Static
Ipv6AddrString只读变更广播当前网口的IPv6地址
PrefixLengthS32只读变更广播当前网口的Ipv6前缀长
Ipv6DefaultGatewayString只读变更广播当前网口的Ipv6默认网关

==方法==


SetIpMaskGateway

设置Ipv4地址、掩码、网关

参数

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

返回值

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

SetIpAddr

设置Ipv4地址

参数

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

SetDefaultGateway

设置ipv默认网关

参数

  • DefaultGateway: String - 默认网关

SetIpv6PrefixGateway

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

参数

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

返回值

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

SetIpv6Addr

设置Ipv6地址、前缀长度

参数

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

SetIpv6DefaultGateway

设置Ipv6默认网关

参数

  • DefaultGateway: String - 默认网关

EnableFloatIp

是否使能浮动ip

参数

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

返回值

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

bmc.kepler.Managers.EthernetInterfaces.InnerNetwork

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播内网ID
EthIdU8只读变更广播网口号,表示IP在哪个eth口上
EthNameString只读变更广播网口名称,带有vlan和别名,例如:eth0.702:1
IpAddrString只读变更广播内网IPv4地址
SubnetMaskString只读变更广播IPv4子网掩码
StatusBoolean只读变更广播该内网网口是否是running状态,即网口上是否有IP
VLANIdU16只读变更广播VLANId,0表示VLAN关闭,反之为开启,范围为1-4094

bmc.kepler.Managers.EthernetInterfaces.Ipv4

==属性==

属性名类型可读写信号通知描述
IpModeString读写变更广播IPv4模式(DHCP/Static)
IpAddrString只读变更广播IPv4地址
BackupIpAddrString读写变更广播备份IPv4地址
SubnetMaskString只读变更广播IPv4子网掩码
BackupSubnetMaskString读写变更广播备份IPv4掩码
DefaultGatewayString只读变更广播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

==属性==

属性名类型可读写信号通知描述
IpModeString读写变更广播DHCPv6:自动获取,Static:手动配置
IpAddrString只读变更广播IP地址
PrefixLengthS32只读变更广播Ipv6地址子网掩码
ScopeString只读变更广播enum(Link,Global)
DefaultGatewayString只读变更广播默认网关

==方法==


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

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播网口Id
EthIdU8只读变更广播网口号
DeviceIdU8只读变更广播设备Id
DevicePortIdU8只读变更广播设备网口Id
SilkscreenString只读变更广播端口丝印信息
TypeString只读变更广播网卡类型
AdaptiveFlagBoolean读写变更广播是否参与自适应标志
LinkStatusString读写变更广播link状态,Connected/Disconnected
MacString只读变更广播对应Eth网口的Mac地址
VLANEnabledBoolean只读变更广播对应Eth的vlan状态
VLANIdU16只读变更广播对应Eth的VLANId
MinVLANIdU16只读变更广播VLAN取值范围下限值
MaxVLANIdU16只读变更广播VLAN取值范围上限值
NegotiatedSpeedMbpsU8读写变更广播表征当前网口的协商速率, 取值有: 0: 不涉及协商速率 1: 10M 2: 100M 3: 1000M

bmc.kepler.Managers.FaultPrediction

==属性==

属性名类型可读写信号通知描述
DfpEnableBoolean读写变更广播硬盘故障预测功能开关: false,关闭;true,打开
DiskLifespanEstimateAlarmEnabledBoolean读写变更广播硬盘预估寿命过低告警开关: false,关闭;true,打开
DiskLifespanEstimateEnabledBoolean读写变更广播硬盘寿命预估功能开关: false,关闭;true,打开
OpticalModuleDeteriorationPredictionEnabledBoolean读写变更广播光模块劣化预测功能开关,false表示关闭,true表示使能。

bmc.kepler.Managers.FileTransfer

==属性==

属性名类型可读写信号通知描述
HttpsTransferCertVerificationBoolean读写变更广播是否校验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

==属性==

属性名类型可读写信号通知描述
IdU8读写变更广播控制台Id
PersistentUSBConnectionEnabledBoolean读写变更广播虚拟键鼠是否支持连接
VideoEnabledBoolean只读变更广播录像使能
ScreenshotEnabledBoolean只读变更广播最后一屏使能
VideoAttributesArray只读变更广播录像文件信息
ScreenshotAttributesArray只读变更广播截屏创建时间
LocalKvmEnabledBoolean读写变更广播本地kvm使能
LocalKvmAutoDisableBoolean读写变更广播远程KVM连接时自动关闭本地KVM设置,false表示不自动关闭本地KVM,true表示自动关闭本地KVM
AutoOSLockEnabledBoolean读写变更广播系统自动锁定使能
AutoOSLockTypeString读写变更广播系统自动锁定方式
AutoOSLockKeyString[]读写变更广播系统自动锁定自定义快捷键
AutoScreenshotTriggersU32[]读写变更广播自动截屏触发类型
DisableKeyboardDuringBiosStartupBoolean读写变更广播BIOS启动过程中是否允许kvm键盘输入

==方法==


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

==属性==

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

==方法==


Beat

心跳检测


bmc.kepler.Managers.IpmbEth

==属性==

属性名类型可读写信号通知描述
IPMIChannelIdU8只读变更广播IPMI通道ID,关联IPMIChannel
SMM1LinkStatusU8只读变更广播与管理板0的通信状态,0:正常;1:异常
SMM2LinkStatusU8只读变更广播与管理板1的通信状态,0:正常;1:异常

bmc.kepler.Managers.LLDPInfo

==属性==

属性名类型可读写信号通知描述
PortNameString只读变更广播LLDP 报文解析出来的端口号
PortDescString只读变更广播LLDP 报文解析出来的端口描述
SystemDescString只读变更广播LLDP 报文解析出来的交换机型号
OrgSpecString只读变更广播LLDP 报文解析出来的组织型号
ManagementIPU32只读变更广播LLDP 报文解析出来的管理地址
SlotIdU8读写变更广播机柜端口对应的U位号,默认0,系列化计算之后反写到该属性

bmc.kepler.Managers.LLDPReceive

==属性==

属性名类型可读写信号通知描述
PortIdString只读变更广播LLDP对端的端口号
PortDescriptionString只读变更广播LLDP对端的端口描述
SystemDescriptionString只读变更广播LLDP对端的系统描述
CustomDataString只读变更广播LLDP对端的组织特定数据信息,自定义TLV
ManagementAddressIPv4String只读变更广播LLDP对端的管理IPv4地址
ManagementAddressIPv6String只读变更广播LLDP对端的管理IPv6地址
ManagementAddressMACString只读变更广播LLDP对端的管理MAC地址

bmc.kepler.Managers.LldpConfig

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播LLDP服务使能:true为使能,默认不使能
WorkModeString读写变更广播LLDP工作模式,目前仅支持Tx模式
TxDelaySecondsS32读写变更广播LLDP Tx延时
TxIntervalSecondsS32读写变更广播LLDP Tx间隔时间
TxHoldS32读写变更广播LLDP Tx保持时间

bmc.kepler.Managers.LocalOMService.USB

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播资源Id
SupportedBoolean只读变更广播是否支持USB type-c功能
PresenceBoolean只读变更广播面板USB口是否在位
EnabledBoolean只读变更广播USB typc-c功能使能状态
USBDevicePresenceBoolean只读变更广播USB设备在位状态

==方法==


SetEnabled

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

参数

  • Enabled: Boolean - 使能状态

StopUSBNetwork

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


bmc.kepler.Managers.LogService

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
OperationLogAlmostFullU8只读变更广播表示操作日志是否超90%
SecurityLogAlmostFullU8只读变更广播表示安全日志是否超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

==属性==

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

bmc.kepler.Managers.Multihost

==属性==

属性名类型可读写信号通知描述
HostTypeString只读变更广播表征当前机型的Host类型,默认是Singlehost
HostCountU8只读变更广播表征当前机型的Host个数,默认是1,取值范围:[1 - 63]

bmc.kepler.Managers.NandFlash

==属性==

属性名类型可读写信号通知描述
VendorString只读变更广播nand厂商
WriteProtectionU8读写变更广播Nand Flash写保护状态,写入与否:0(允许)/1(禁止)
LifeTimeU8只读变更广播剩余寿命百分比,支持Nand Flash已用寿命超限严重告警
LifeTimeThresholdU8只读变更广播寿命阈值
PreEOLU8只读变更广播(end of life)Nand Flash的PreEOL信息(通过平均预留块来反映设备寿命),
OverWriteU8只读变更广播写入量是否超过门限,1:超过/0:未超过
WriteThresholdU8只读变更广播Nand Flash写入量,单位GB
RWTestStateU8只读变更广播读写测试状态
MaxEraseCountS32只读变更广播最大擦除次数(非JPR型号海力士支持),不支持厂商置-1
RemainingEraseCountS32只读变更广播剩余擦除次数(非JPR型号海力士支持),不支持厂商置-1
EraseCountPerDaysS32[]只读变更广播最近15天每天擦除次数(非国产海力士支持),不支持或无数据为空
TotalWriteAmountDouble只读变更广播开机至今总写入量,单位GB
TotalWriteAmountIn15DaysDouble只读变更广播最近15天总写入量,单位GB
WriteAmountPerDayDouble[]只读变更广播最近15天每天写入量,无数据时为空,单位GB
ReservedBlocksS32只读变更广播剩余预留块(非JPR型号海力士支持),不支持厂商置-1
RuntimeBadBlocksS32只读变更广播坏块数量(非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

==属性==

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

bmc.kepler.Managers.NetworkProtocol.PortConfig

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播使能状态
PortCountU8只读变更广播端口数量, 支持0~2个端口号
DefaultPortU16只读变更广播默认主端口号
PortU16读写变更广播当前主端口号
DefaultSparePortU16只读变更广播默认备端口号
SparePortU16读写变更广播当前备端口号

==方法==


SetPorts

设置网络协议的端口号

参数

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

bmc.kepler.Managers.NetworkProtocol.SNMP

==属性==

属性名类型可读写信号通知描述
SNMPv1EnabledBoolean读写变更广播SNMPv1使能状态
SNMPv2cEnabledBoolean读写变更广播SNMPv2c使能状态
SNMPv3EnabledBoolean读写变更广播SNMPv3使能状态
SysNameString读写变更广播系统名称
SysNameSyncEnabledBoolean读写变更广播是否从主机名同步系统名
SysContactString读写变更广播系统联系人
SysLocationString读写变更广播系统位置
EngineIdString只读变更广播引擎Id

bmc.kepler.Managers.NetworkProtocol.SSH

==属性==

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

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithm

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播算法名称
EnabledBoolean读写变更广播使能状态

bmc.kepler.Managers.NetworkProtocol.SSH.Algorithms

==方法==


SetAlgorithmsState

设置算法使能状态

参数

  • AlgorithmsState: Array - 算法使能状态

==自定义类型==


AlgorithmsStateItem: 结构体类型

  • Name: String
  • Enabled: Boolean

bmc.kepler.Managers.NodeLocation

==属性==

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

bmc.kepler.Managers.Ntp

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播NTP使能状态,是否开启NTP客户端
NTPModeString读写变更广播配置服务器ip模式,Static手动配置ip,IPv4/IPv6表示依赖DHCP服务器获取NTP服务器ip地址
NTPIpVersionString读写变更广播NTPIp类型
PreferServerString读写变更广播首选服务器
AlternateServerString读写变更广播备用服务器
ExtraServersString[]读写变更广播额外服务器
MinPollU8读写变更广播最小轮询间隔,代表两个NTP报文的最小间隔时间,配置3代表2秒的3次方
MaxPollU8读写变更广播最大轮询间隔
NTPServerCountU8读写变更广播支持可配置NTPserver的个数
SyncResultU8只读变更广播BMC与NTP服务器同步的结果
CurrentPollingIntervalSecondsU32只读变更广播NTP当前轮询时间,单位为秒;在BMC运行时且NTP功能打开时有效,关闭时为0

==方法==


SetPollingInterval

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

参数

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

SetNtpExtraServers

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

参数

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

bmc.kepler.Managers.Ntp.Auth

==属性==

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

==方法==


ImportGroupKey

导入NTP组密钥

参数

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

ImportGroupKeyWithContent

导入NTP组密钥

参数

  • Content: String - 上传密钥内容

ImportGroupKeyAsync

导入NTP组密钥

参数

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

返回值

  • TaskId: U32 - 任务Id

bmc.kepler.Managers.Package

==属性==

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

bmc.kepler.Managers.RMCPCipherSuites

==属性==

属性名类型可读写信号通知描述
SuitIdU8只读变更广播算法套件Id,取值: 1,2,3,17
EnabledBoolean读写变更广播加密套件的使能状态
AuthenticationAlgorithmString只读变更广播加密算法名称
IntegrityAlgorithmString只读变更广播一致性算法名称
ConfidentialityAlgorithmString只读变更广播验证算法名称

bmc.kepler.Managers.Rmcp.SessionService

==属性==

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

bmc.kepler.Managers.SOC

==属性==

属性名类型可读写信号通知描述
BlackBoxEnabledBoolean读写变更广播设置黑匣子使能开关状态,false(关闭)/true(打开)
PCIeControllerEnabledBoolean读写变更广播设置PCIe接口使能开关状态,false(关闭)/true(打开)
TemperatureU16只读变更广播BMC核心温度
TemperatureThresholdU16只读变更广播BMC核心温度告警阈值
NameString只读变更广播芯片名字
VersionString只读变更广播芯片版本,如V100
DesignatorString只读变更广播芯片位置,如U82
DIEIDString只读变更广播DIE(裸片)ID(标识)
ResetTypeU8只读变更广播BMC复位原因 0 AC复位,2 软复位
DDRSelfTestResultU8只读变更广播DDR自检结果,bmc启动检查一次 0 无异常 1 发生异常
DDRSingleBitECCStatisticsU32只读变更广播DDR ECC错误检查,1小时例测一次单bit结果
DDRMultiBitECCStatisticsU32只读变更广播DDR ECC错误检查,1小时例测一次多bit结果
StartupDurationU16只读变更广播BMC启动时间规格
LastResetTimeString只读变更广播表征BMC上一次重启时间

bmc.kepler.Managers.SOC.BlackBox

==方法==


Dump

黑匣子信息转储

参数

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

bmc.kepler.Managers.SOC.Coprocessor

==属性==

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

bmc.kepler.Managers.SOC.DDR

==方法==


SetTestParameters

设置DDR测试参数

参数

  • TestParams: Object - DDR测试参数

GetTestParameters

查询DDR测试参数

返回值

  • TestParams: Object - DDR测试参数

==自定义类型==


Object: 结构体类型

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

bmc.kepler.Managers.SOC.EfuseUpgrade

==方法==


Write

efuse升级数据写入接口

参数

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

bmc.kepler.Managers.SOC.Env

==属性==

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

==自定义类型==


EnvActiveModes: 枚举类型

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

bmc.kepler.Managers.SOC.GMAC

==方法==


SetMacAddr

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

参数

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

GetMacAddr

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

参数

  • GMacId: U8 - GMAC控制器的Id

返回值

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

bmc.kepler.Managers.SOC.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

==属性==

属性名类型可读写信号通知描述
WriteProtectionBoolean读写变更广播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

查询安全启动状态信息

返回值

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

==自定义类型==


CertificateHashSignMode: 枚举类型

  • 0: PKCSSignMode
  • 1: PSSSignMode

bmc.kepler.Managers.SOC.SecureCore.TPCM

==属性==

属性名类型可读写信号通知描述
PresenceBoolean只读变更广播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: 枚举类型

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

ScopeSel: 枚举类型

  • 0: BeforeAFESampling
  • 1: AfterAFESampling

bmc.kepler.Managers.SOC.UsbDrd

==方法==


GetRole

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

参数

  • UsbId: U8 - 复合设备USB口

返回值

  • Role: Enum - 具体角色类型:Role(enum,0:Device,1:Host)

SetRole

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

参数

  • UsbId: U8 - 复合设备USB口
  • Role: Enum - 具体角色类型:Role(enum,0:Device,1:Host)

==自定义类型==


Role: 枚举类型

  • 0: Device
  • 1: Host

bmc.kepler.Managers.SOL

==属性==

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

==方法==


InitSession

初始化会话

参数

  • Mode: U8 - 会话模式

返回值

  • Result: S8 - 初始化结果

SetTimeout

设置超时时间

参数

  • Minutes: U16 - 超时时间

返回值

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

bmc.kepler.Managers.SOL.Session

==属性==

属性名类型可读写信号通知描述
ActivatedBoolean只读变更广播SOL会话激活状态
TypeString只读变更广播会话类型,取值: CLI, IPMI
ClientAddressString只读变更广播客户端会话地址
ActivatedTimeString只读变更广播会话创建时间
UserNameString只读变更广播登录用户名

==方法==


Deactivate

停用SOL会话

返回值

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

bmc.kepler.Managers.SSDPConfig

==属性==

属性名类型可读写信号通知描述
ProtocolEnabledBoolean只读变更广播协议使能状态
ModeString读写变更广播SSDP运行的模式
TypeString只读变更广播BMC为__initialized.__bmc-
EthernetInterfaceString只读变更广播使用的网口
NotifyMulticastIntervalSecondsU32读写变更广播Alive消息发送的时间间隔
IPv4AddrString只读变更广播SSDP组播IPv4地址
IPv6AddrString只读变更广播SSDP组播IPv6地址
NotifyTTLU32读写变更广播SSDP hop count

==方法==


SetNotifyIPv6Scope

设置ipv6 scope

参数

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

bmc.kepler.Managers.SecureBoot

==属性==

属性名类型可读写信号通知描述
VerificationEnabledBoolean只读变更广播标识当前是否安全启动

==方法==


SetBiosSignature

设置Bios安全启动签名值

参数

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

bmc.kepler.Managers.SecureBoot.Signature

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播安全启动固件名
SignatureString只读变更广播安全启动固件签名值
VerificationResultU8只读变更广播安全启动校验结果:0-验签成功,1-验签失败,255-未进行验签

bmc.kepler.Managers.Security.Asset

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播部件名称
StandardDescriptionString只读变更广播基准度量内容,由部件信息组合,签名而来
StandardDigestString只读变更广播度量基准值

bmc.kepler.Managers.Security.Assets

==属性==

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

==方法==


SignComponents

参数

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

GetComponentsDigest

参数

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

返回值

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

GenerateServerConfigDigest

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

参数

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

返回值

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

ClearServerConfigDigest

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


==自定义类型==


ComponentContent: 结构体类型

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

AssetDigest: 结构体类型

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

bmc.kepler.Managers.Security.Banner

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播使能状态
ContentString读写变更广播展示的banner内容
DefaultContentString读写变更广播默认的banner内容

bmc.kepler.Managers.Security.DICE

==方法==


ExportCSR

导出DICE CSR

参数

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

返回值

  • TaskId: U32 - ExportCSR Task Id

ImportCertificate

导入DICE CERT0证书

参数

  • Path: String - 证书路径

返回值

  • TaskId: U32 - ImportCertificate Task Id

ExportCertificateChain

导出DICE证书链

参数

  • 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

文件复制,对应cp

参数

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

Move

文件移动,对应mv

参数

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

Chmod

修改文件权限,对应chmod

参数

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

Chown

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

参数

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

Delete

删除文件,对应rm

参数

  • DstFile: String - 目标文件路径

Create

使用fopen创建文件

参数

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

ChangeOwner

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

参数

  • DstFile: String - 目标文件路径

返回值

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

IsPermitted

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

参数

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

返回值

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

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

==属性==

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

==方法==


EnterRecoveryMode

进入最小系统接口

返回值

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

SetIDSConfig

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

参数

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

bmc.kepler.Managers.Security.TlsConfig.CipherSuit

==属性==

属性名类型可读写信号通知描述
EnabledBoolean只读变更广播使能状态
SuitNameString只读变更广播算法名称

bmc.kepler.Managers.Security.TlsConfig.CipherSuits

==方法==


SetSslCipherSuit

设置SSL加密套件

参数

  • SuitArray: Array
  • EnableArray: Boolean[]

==自定义类型==


SslCipherSuit: 枚举类型

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

bmc.kepler.Managers.Security.TlsConfig.TlsVersion

==属性==

属性名类型可读写信号通知描述
VersionEnum读写变更广播TLS版本
TLS_1_0_EnabledBoolean读写变更广播TLS1.0版本使能
TLS_1_1_EnabledBoolean读写变更广播TLS1.1版本使能
TLS_1_2_EnabledBoolean读写变更广播TLS1.2版本使能
TLS_1_3_EnabledBoolean读写变更广播TLS1.3版本使能
GMTLSEnabledBoolean读写变更广播GMTLS版本使能

==方法==


GetTlsCapabilities

获取TLS各版本支持情况

返回值

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

==自定义类型==


SslVersion: 枚举类型

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

TlsObject: 结构体类型

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

bmc.kepler.Managers.SerialManagement

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播串口链路的Id
AvailabilityU8只读变更广播串口链路的可用性
CurrentConnectStatusU8只读变更广播当前串口连接状态,0:未连接,1:已连接
SourceString只读变更广播链路关系源端
DestinationString只读变更广播链路关系对端
SrcSerialU8只读变更广播源Uart或Port口,其中取值大于16是Port,否则是Uart
DestSerialU8只读变更广播目的Uart或Port口,其中取值大于16是Port,否则是Uart

==方法==


SetConnectStatus

设置串口链路状态

参数

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

bmc.kepler.Managers.SerialManagement.Config

==方法==


Reset

恢复串口管理配置


bmc.kepler.Managers.SnmpService.SnmpCommunity

==属性==

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

==方法==


SetRwCommunity

设置rw snmp团体名

参数

  • RwCommunity: String

SetRoCommunity

设置ro snmp团体名

参数

  • RwCommunity: String

GetSnmpCommunity

获取snmp团体名

返回值

  • RwCommunity: String
  • RoCommunity: String

SetSnmpCommunityLoginRule

设置snmp团体名登录规则

参数

  • LoginRuleIds: String[]

bmc.kepler.Managers.SwitchConnections

==方法==


GetSwitchConnections

获取交换机连接信息

返回值

  • Connections: String - 交换机信息

bmc.kepler.Managers.Syslog

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播syslog服务使能
MessageFormatString读写变更广播消息格式
ServerIdentitySourceString读写变更广播主机标识
LowestSeverityString读写变更广播告警级别
ProtocolString读写变更广播传输协议
AuthenticateModeString读写变更广播认证模式

bmc.kepler.Managers.Syslog.Report

==方法==


ReportControl

通知组件syslog日志上报

参数

  • Type: TypeData
  • Priority: U8

==自定义类型==


TypeData: 结构体类型

  • key: String
  • value: String

bmc.kepler.Managers.Syslog.Server

==属性==

属性名类型可读写信号通知描述
MemberIdU8只读变更广播数组序号
EnabledBoolean读写变更广播通道使能
AddressString读写变更广播服务器地址
PortU16读写变更广播服务器端口号
LogTypeString[]读写变更广播日志类型
OperationLogEnabledBoolean读写变更广播操作日志使能状态
SecurityLogEnabledBoolean读写变更广播安全日志使能状态
EventLogEnabledBoolean读写变更广播事件日志使能状态
IntrusionDetectionLogEnabledBoolean读写变更广播入侵检测日志使能状态
SysComLogEnabledBoolean读写变更广播系统串口日志使能状态
BmcComLogEnabledBoolean读写变更广播BMC串口日志使能状态
DiagnosticLogEnabledBoolean读写变更广播故障诊断日志使能状态
ChipLogEnabledBoolean读写变更广播板卡芯片日志使能状态

bmc.kepler.Managers.Syslog.Servers

==方法==


SubmitTestEvent

发送测试事件

参数

  • MemberId: U8 - 数组序号

bmc.kepler.Managers.SystemManager

==属性==

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

bmc.kepler.Managers.TPCM.BaseInfo

==属性==

属性名类型可读写信号通知描述
TCMManufacturerU16只读变更广播TCM厂商ID
TCMVersionU32只读变更广播TCM版本
TPCMLogVersionU32只读变更广播TPCM日志版本
TsbEnableStatusBoolean只读变更广播TSB使能

bmc.kepler.Managers.TPCM.Config

==属性==

属性名类型可读写信号通知描述
TrustedCenterServerAddrString读写变更广播外部可信中心IP
MeasureEnableBoolean读写变更广播度量使能
MeasureControlPolicyBoolean读写变更广播度量控制策略

==方法==


RefreshBIOSDigest

bios升级时刷新基准值

返回值

  • TaskId: U8 - 任务Id

GetTsbLicense

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

返回值

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

RefreshComponentStandardDigest

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

参数

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

bmc.kepler.Managers.TPCM.Measured

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播度量固件名
VersionString只读变更广播度量固件版本
PCRNameString只读变更广播平台状态寄存器
ActualDigestString只读变更广播实际度量值
StandardDigestString读写变更广播度量基准值
ComparedResultU8只读变更广播度量结果
ControlActionU8只读变更广播控制结果

bmc.kepler.Managers.Time

==属性==

属性名类型可读写信号通知描述
DateTimeString只读变更广播遵循ISO 8601标准的日期时间字符串
TimeZoneConfigurableBoolean只读变更广播时区是否可配置
DateTimeLocalOffsetString只读变更广播时区偏移量
TimeZoneNameString读写变更广播时区名字
SyncStatusBoolean只读变更广播当前BMC时间是否已同步
DSTEnabledBoolean只读变更广播夏令时是否已开启

==方法==


SetDateTime

设置BMC时间相关属性

参数

  • TimeParams: KeyValueTable - TimeZone:设置的时区,TimeStamp:时间戳,DSTEnable:夏令时使能状态(true、false)

SetRtcTime

设置RTC时间

参数

  • TimeStamp: U64 - 时间戳

==自定义类型==


KeyValueTable: 结构体类型

  • key: String
  • value: String

bmc.kepler.Managers.USBAuthentication

==方法==


SetDecryptPassword

设置usb解压密码

参数

  • USBDecryptPassword: String

DecryptFile

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

参数

  • SourcePath: String
  • TargetPath: String

返回值

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

bmc.kepler.Managers.Uart

==方法==


UartConnectUart

设置uart与uart互联状态

参数

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

UartConnectPort

设置uart和uart port互联状态

参数

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

PortConnectPort

设置uart port之间的互联关系

参数

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

QueryConnection

查询uart和port互联关系

返回值

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

UartOpen

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

参数

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

UartClose

关闭uart控制器

参数

  • UartId: U8 - uart控制器id

SetBaudRate

设置uart控制器波特率

参数

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

SetDataBit

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

参数

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

SetStopBit

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

参数

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

SetParityBit

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

参数

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

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

==属性==

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

==方法==


Export

导出串口日志

参数

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

返回值

  • TaskId: U32 - 任务标识

bmc.kepler.Managers.Ums

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播U盘名字
CapacityKBU32只读变更广播u盘容量单位 kByte
FileSystemString只读变更广播U盘flash对应的设备名称
BmcAccessModeString只读变更广播U盘在BMC侧的读写权限
OsAccessModeString只读变更广播U盘在主机侧的读写权限
FlashDevString只读变更广播U盘flash对应的设备名称
MountPointString只读变更广播u盘挂载点
EnableBoolean只读变更广播U盘功能使能
BiosSupportBoolean只读变更广播BIOS支持U盘功能标志
FreeUpdateSpaceBytesU32只读变更广播U盘更新文件夹剩余容量 单位 byte
MaxUpdateSpaceBytesU32读写变更广播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

==属性==

属性名类型可读写信号通知描述
PackageCountU8只读变更广播U盘中含有BMA安装包的个数
PackagesObject只读变更广播type: U盘中BMA安装包支持的操作系统类型, version: U盘中BMA安装包的版本号
StateU8只读变更广播板载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

==属性==

属性名类型可读写信号通知描述
ConfigFileReadyBoolean读写变更广播u盘 部件配置或升级包下发到NAND FLASH完成标志
SysRestartDelaySecondsU32读写变更广播u盘从SP操作(配置和升级)完后到复位主机系统之间间隔时间, 单位为秒
SPTimeoutU32读写变更广播SP部署超时时间300 ~ 86400,默认7200
SPFinishedBoolean读写变更广播SP部署事务状态
SPDeviceInfoCollectEnabledBoolean读写变更广播SP设备信息文件收集开关
SPAutoUpgradeSupportedBoolean只读变更广播是否支持使用Auto模式升级SP
StartModeU8读写变更广播u盘进入SP方式标志 0:手动按F6进入SP,1:自动进入SP
DataExistBoolean只读变更广播bmc中是否存在sp程序
BootedFlagBoolean读写变更广播从SP启动过的标志,1表示从SP启动过;0表示没有从SP启动过,重启持久化
DeviceInfoCollectStateU8只读变更广播SP设备信息文件收集流程状态
DeviceInfoParseStateU8只读变更广播SP设备信息文件解析流程状态
BootCountU32只读变更广播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

==属性==

属性名类型可读写信号通知描述
APPVersionString只读变更广播SP应用程序版本
OSRevisionString只读变更广播自定义的SP的OS版本
OSVersionString只读变更广播SP中欧拉OS的版本
MajorVersionString只读变更广播SP中主版本
DataVersionString只读变更广播SP中驱动版本
ComponentsMessagesString只读变更广播SP中组件信息:所有的组件名字和各组件对应的本号

bmc.kepler.Managers.Ums.Upgrade

==属性==

属性名类型可读写信号通知描述
InUpgradeBoolean只读变更广播当前是否处于升级中
UpgradeProgressU8只读变更广播升级进度
TransProgressS32只读变更广播u盘文件传输进度
TransFileNameString只读变更广播当前正在传输的文件
StatusString只读变更广播升级状态
MessageIdString只读变更广播升级出错时错误消息的id
MessageArgsString[]只读变更广播升级出错时错误消息的参数

bmc.kepler.Managers.UsbDevice.Cdrom

==属性==

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

==方法==


Connect

Cdrom设备建立连接

返回值

  • UsbId: U32 - 复合设备USB口
  • FuncId: U32 - 功能设备ID

Disconnect

Cdrom设备断开连接


bmc.kepler.Managers.UsbDevice.Floppy

==属性==

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

==方法==


Connect

软驱建立连接

返回值

  • UsbId: U32 - 复合设备USB口
  • FuncId: U32 - 功能设备ID

Disconnect

软驱断开连接


bmc.kepler.Managers.UsbDevice.KeyMouse

==属性==

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

==方法==


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

==属性==

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

==方法==


Connect

LCD设备建立连接


Disconnect

LCD设备断开连接


bmc.kepler.Managers.UsbDevice.Ums

==属性==

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

==方法==


Connect

u盘建立连接

参数

  • FlashDev: String - u盘设备名称

返回值

  • UsbId: U32 - 复合设备USB口
  • FuncId: U32 - 功能设备ID

Disconnect

u盘断开连接


bmc.kepler.Managers.VirtualMedia.CD

==属性==

属性名类型可读写信号通知描述
IdU8读写变更广播虚拟媒体ID
ConnectedViaString读写变更广播虚拟媒体连接途径
ImageString读写变更广播远程镜像URI
ImageNameString读写变更广播远程镜像文件名
MediaTypesString[]读写变更广播虚拟媒体类型
ConnectNumU8读写变更广播虚拟媒体连接数量
ConnectStateU8读写变更广播虚拟媒体连接状态

==方法==


InsertMedia

插入媒体

参数

  • Image: String - 镜像URI

返回值

  • TaskId: U32 - 任务标识

EjectMedia

弹出媒体

返回值

  • TaskId: U32 - 任务标识

bmc.kepler.Managers.VncService

==属性==

属性名类型可读写信号通知描述
IdU8读写变更广播VNC服务Id
SSLEncryptionEnabledBoolean只读变更广播ssl加密使能
KeyboardLayoutString只读变更广播键盘模式,取值: en:美式键盘, jp:日式键盘, de:德式键盘
DisableKeyboardDuringBiosStartupBoolean读写变更广播BIOS启动过程中是否允许vnc键盘输入

==方法==


SetSSLEncryptionEnabled

设置ssl加密使能

参数

  • Enabled: Boolean - 是/否

SetKeyboardLayout

设置键盘布局

参数

  • Enabled: String - VNC键盘布局

bmc.kepler.Manufacture

==属性==

属性名类型可读写信号通知描述
TypeU8只读变更广播装备测试项类型,1人工自检,2需要人工准备前置条件,3拷机测试,4人工检查结果,5人工操作测试,6与装备交互测试
IdU8只读变更广播装备测试项id
SlotU32只读变更广播槽位号
DeviceNumU8只读变更广播设备id
ParamU8[]读写变更广播测试项传入的参数
ItemNameString只读变更广播设备名称
PrompteReadyString只读变更广播测试前交互提示
PrompteFinishString只读变更广播测试完成交互提示
ProcessPeriodU16只读变更广播测试所需时间
StatusString只读变更广播当前测试状态

==方法==


Start

开始装备测试项


Stop

停止装备测试项


GetResult

获取装备测试项结果

返回值

  • Status: String - 装备测试项状态
  • Description: String - 装备测试项描述

bmc.kepler.Manufacture.Extension

==属性==

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

bmc.kepler.Manufacture.Simulate

==属性==

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

bmc.kepler.Manufacture.Status

==属性==

属性名类型可读写信号通知描述
ModeU8只读变更广播装备模式:0表示ft阶段,1表示st阶段或者正常运行阶段
EnabledBoolean只读变更广播装备使能: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

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播组件名称
VersionString只读变更广播组件版本号
AuthorString只读变更广播组件作者
LicenseString只读变更广播组件证书
PidS32只读变更广播组件pid
DescriptionString只读变更广播组件的描述信息
StatusString只读变更广播组件状态

==方法==


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

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
ClassNameString只读变更广播对象类名
ObjectNameString只读变更广播对象名
ObjectIdentifierStruct只读变更广播对象标志符

==方法==


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

==属性==

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

==方法==


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

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播遥测使能状态
TLSModeString读写变更广播遥测认证方式,TLS:单向,mTLS:双向

bmc.kepler.ObservabilityService.Receiver

==属性==

属性名类型可读写信号通知描述
ReceiverIdU8只读变更广播接收端序号
EnabledBoolean读写变更广播接收端使能状态
AddressString读写变更广播接收端地址
PortU16读写变更广播接收端端口
ProtocolString读写变更广播传输协议

==方法==


SubmitTestTelemetryData


bmc.kepler.Persistence

==方法==


HasTableHistoryRecord

查询表格是否曾经存在过

参数

  • TableName: String - 查询的表面

返回值

  • Result: Boolean - 查询的结果

bmc.kepler.ProductInfo.FruCtrlCapabilities

==属性==

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

bmc.kepler.Redfish.Task

==方法==


GetTaskId

获取Redfish任务Id

参数

  • TaskId: U32

返回值

  • RedfishTaskId: U32 - 资源数的任务Id映射的Redfish任务Id, 0表示任务不存在

bmc.kepler.Release.Maintenance

==方法==


Dloglimit

设置组件日志限流状态

参数

  • Enabled: unknown - 日志限流使能,true代表限流,false代表不限流
  • DurationMins: U8 - 设置日志限流状态生效时长[1-720]min

bmc.kepler.Release.MonitorControl

==方法==


SetMonitorStatus

用于开启或关闭指定的检查机制的命令, 包括组件启动状态检查、组件运行状态检查、组件在线状态检查

参数

  • Type: String - 表示使能的检查机制类型, 参数选择包括:starting(启动状态检查), running(运行状态检查), online(组件在线状态检查)
  • Enabled: Boolean - 开启或关闭检查机制的开关, true表示开启, false表示关闭

返回值

  • Result: S32 - 表示使能检查机制启停的结果, 0代表成功, -1代表失败

bmc.kepler.Release.OnePower.Collector

==方法==


GetFanSpeed

获取电源风扇转速

返回值

  • FanSpeed: U16 - 电源风扇转速

GetRegisterValue

获取电源寄存器信息

参数

  • Cmd: U32 - 电源寄存器地址
  • Length: U32 - 读取长度

返回值

  • OutData: U8[] - 寄存器读取结果

bmc.kepler.Release.Performance.Metrics.PropertyChange

==方法==


GetStatus

获取Redfish资源协作接口变更统计开关状态

返回值

  • Status: Boolean - Redfish资源协作接口变更统计特性开关状态

SetStatus

设置Redfish资源协作接口变更统计开关状态

参数

  • Status: Boolean - Redfish资源协作接口变更统计特性开关状态

GetReport

获取资源协作接口变更统计报告

返回值

  • Report: String - json格式的统计数据

bmc.kepler.Release.Storage.Controller

==方法==


GetControllerInfo

打印运行时RAID卡的数据

参数

  • ControllerId: U8 - 表示控制器的ID

返回值

  • Details: Details - 表示运行时RAID卡的数据

==自定义类型==


Details: 结构体类型

  • key: String
  • value: String

bmc.kepler.Release.ThermalControlStrategy

==方法==


GetActivatedPolicy

获取指定散热器件和模式生效的调速因子

参数

  • Type: String - 散热器件类型
  • Mode: U8 - 查询模式,0表示生效因子,1表示生效算法

返回值

  • ActivatedPolicy: String

bmc.kepler.Release.TraceChip

==方法==


TraceChip

控制芯片对象的实时数据跟踪。start:开始跟踪,stop:停止跟踪

参数

  • Action: String - trace动作,start:跟踪芯片对象的读写数据,stop:停止跟踪芯片对象的读写数据

bmc.kepler.Scanner

==属性==

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

bmc.kepler.Scanner.Aggregate

==属性==

属性名类型可读写信号通知描述
AggregateOffsetU32只读变更广播Scanner在汇聚数据中的相对偏移
AggregateStatusBoolean只读变更广播Scanner是否从汇聚数据中读取到, 由hwproxy动态设置结果

bmc.kepler.SessionService

==属性==

属性名类型可读写信号通知描述
SessionTimeoutU32读写变更广播会话超时时间(秒)
SessionModeU32读写变更广播会话占用模式,0共享模式,1独占模式
SessionMaxCountU32只读变更广播最大会话数
ServiceEnabledBoolean只读变更广播是否允许创建会话

bmc.kepler.SessionService.Session

==属性==

属性名类型可读写信号通知描述
ClientOriginIPAddressString只读变更广播客户端ip
CreatedTimeString只读变更广播会话创建时间
SessionIdString只读变更广播会话Id
OemSessionTypeS8只读变更广播OEM会话类型,包括Sso、web、内部redfish会话类型等
AccountPasswordString只读变更广播适配redifsh标准,实际未上树,默认null
SessionTypeString只读变更广播会话类型,包括GUI、Redfish、CLI等
UserNameString只读变更广播登录用户名
LastLoginIpString只读变更广播上次登录ip
LastLoginTimeString只读变更广播上次登录时间
AuthTypeS8只读变更广播认证类型,包括本地认证、远程认证等
RoleString[]只读变更广播用户角色,包括管理员、操作员等
PrivilegesString[]只读变更广播会话拥有的九大权限
AccountIdString只读变更广播登录用户id
BrowserTypeU8只读变更广播浏览器类型

==方法==


SessionDelete

删除会话

参数

  • LogoutType: U8 - 会话退出类型

bmc.kepler.SessionService.Sessions

==属性==

属性名类型可读写信号通知描述
ValidateSsoClientBoolean读写变更广播SSO登录ip校验使能开关

==方法==


NewSession

创建会话

参数

  • UserName: String
  • Password: U8[]
  • SessionType: U8
  • Domain: String
  • Ip: String
  • ExtraData: ExtraDataDict

返回值

  • Token: String
  • CsrfToken: String
  • SessionId: String

NewRemoteConsoleSession

新建RemoteConsole会话

参数

  • Token: String
  • SessionType: U8
  • SessionMode: U8

返回值

  • RemoteConsoleToken: String
  • RemoteConsoleSessionId: String

NewVNCSession

新建VNC会话

参数

  • CipherText: String
  • AuthChallenge: String
  • SessionMode: U8

返回值

  • VNCSessionId: String

ValidateSessionWithCsrf

基于token认证session的有效性

参数

  • SessionType: U8
  • Token: String
  • CsrfToken: String

返回值

  • SessionId: String

ValidateSession

基于token认证session的有效性

参数

  • SessionType: U8
  • Token: String

返回值

  • SessionId: String

GetSessionLogoutType

获取会话登出原因

参数

  • SessionId: String

返回值

  • LogoutType: U8

SessionHeartBeat

会话心跳,支持指定参数刷新会话不活跃时间

参数

  • SessionId: String
  • RemainActiveSeconds: U8

GetCLISessionList

获取CLI会话列表(基于PID查询)

返回值

  • 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: 枚举类型

  • 0: Shared
  • 1: Exclusive

ExtraDataDict: 结构体类型

  • key: String
  • value: String

SessionType: 枚举类型

  • 0: GUI
  • 1: Redfish
  • 2: CLI
  • 3: SSO
  • 4: KVM
  • 5: VNC
  • 6: KVM_VMM
  • 7: VIDEO
  • 255: ALL

bmc.kepler.SystemControl

==方法==


ForceReset

强制复位BMC的接口

参数

  • ResetType: U8 - 重启类型0:表示下次从正常系统启动,1:表示下次从最小系统启动

GracefulReset

平滑复位BMC的接口

参数

  • ResetType: U8 - 重启类型0:表示下次从正常系统启动,1:表示下次从最小系统启动

返回值

  • OutData: S32 - 返回业务组件善后处理的结果

bmc.kepler.Systems.AirCoolingConfig

==属性==

属性名类型可读写信号通知描述
CtrlModeString只读变更广播风扇控制模式(自动/手动/混合)
CtrlModePersistTypeU8只读变更广播风扇控制模式的持久化类型;0:不持久化、1:复位持久化、2:掉电持久化
CtrlModeResetPersistString只读变更广播复位持久化的风扇控制模式
CtrlModePoweroffPersistString只读变更广播掉电持久化的风扇控制模式
TimeOutU32只读变更广播手动模式下的超时时间
ManualSpeedPercentU8只读变更广播手动模式下的转速级别
ManualSpeedPercentResetPersistU8只读变更广播复位持久化的手动模式下的转速级别
ManualSpeedPercentPoweroffPersistU8只读变更广播掉电持久化的手动模式下的转速级别
SpeedPercentRangeU8[]只读变更广播手动设置转速级别允许范围
MinAllowedSpeedPercentU8读写变更广播失联状态场景风扇转速级别
InitialSpeedPercentU8读写变更广播开机风扇初始转速百分比
ActiveAlgorithmString只读变更广播当前实时生效的算法

==方法==


SetManualSpeedPercent

设置风扇手动模式转速百分比

参数

  • FanId: U8 - 风扇Id
  • SpeedPercent: U8 - 风扇转速百分比

SetCtrlMode

设置风扇控制模式

参数

  • CtrlMode: String - 风扇控制模式
  • Timeout: U32 - 超时时长

SetCtrlModePersist

设置可持久化的风扇控制模式

参数

  • CtrlMode: String - 风扇控制模式
  • CtrlModePersistType: U8 - 当前风扇模式的持久化类型
  • Timeout: U32 - 超时时长

bmc.kepler.Systems.BIOSConfiguration

==属性==

属性名类型可读写信号通知描述
DEMTEnabledBoolean只读变更广播DEMT功能是否开启
RefreshRateU32只读变更广播内存刷新频率

==方法==


SetDEMTEnabled

设置DEMT功能是否开启

参数

  • DEMTEnabled: Boolean - DEMT功能是否开启

SetRefreshRate

设置内存刷新频率

参数

  • RefreshRate: U32 - 内存刷新频率

bmc.kepler.Systems.Bios

==属性==

属性名类型可读写信号通知描述
SystemStartupStateU8只读变更广播Bios启动状态, 枚举值, 0: Bios未启动, 32: Bios初始化ME完成, 64: Bios启动到PCIE信息上报完成, 96: SMBIOS write prepare, 99: SMBIOS write start, 102: SMBIOS write finish, 111: Bios进入PXE, 254: Bios Post阶段完成
SystemIdU8只读变更广播系统Id
VersionString只读变更广播Bios版本信息
BackupVersionString只读变更广播Bios备份版本信息
CurrentValueFileNameString只读变更广播当前生效的配置文件
ResultFileNameString只读变更广播配置生效结果文件
SettingFileNameString只读变更广播待生效配置文件
RegistryFileNameString只读变更广播标准配置文件
MenuDataString只读变更广播菜单数据
MenuChangeFlagU8只读变更广播菜单变动标志
RegistryVersionString只读变更广播标准配置文件的版本
DEMTConfigU8只读变更广播DEMT配置
PcieCardBDFU8[]只读变更广播Pcie卡BDF
PcieDiskBDFU8[]只读变更广播硬盘BDF
OCPCardBDFU8[]只读变更广播OCP卡BDF
BiosBootStageU8只读变更广播Bios启动阶段
UpgradeFailedU8只读变更广播正常升级完成后,BIOS Flash完整性校验状态,主要用于配置告警
RecoverFailedU8只读变更广播自恢复完成后,BIOS Flash完整性校验状态,主要用于配置告警
BiosLogPrintEnabledU8只读变更广播Bios的日志全打印使能状态
SettingsEffectiveStatusString只读变更广播Bios配置文件的生效状态
BiosConfigActiveModeU64只读变更广播设置BIOS配置导入的生效模式, 0:导入BIOS待生效配置,BIOS重启后生效 1:恢复BIOS默认配置,再导入BIOS待生效配置,BIOS重启后生效
TeeOSVersionString只读变更广播TeeOS版本号
ResetBiosToDefaultsPendingBoolean只读变更广播恢复默认命令下发但还没生效,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

==属性==

属性名类型可读写信号通知描述
ActivatedStatusU8只读变更广播Bios无感升级固件生效状态, 枚举值0/1/2, 0:生效完成; 1:待生效; 2:生效中
FirmwareEffectiveStatusU8只读变更广播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

==属性==

属性名类型可读写信号通知描述
SystemIDU8只读变更广播系统Id

bmc.kepler.Systems.Board

==属性==

属性名类型可读写信号通知描述
SlotU8只读变更广播槽位号
NumberU8只读变更广播逻辑编号
PositionString只读变更广播容器信息(如:chassis)
NameString只读变更广播单板名
ProductNameString只读变更广播产品名
SilkTextString只读变更广播丝印信息
ManufacturerString只读变更广播厂商
DescriptionString只读变更广播单板描述
BoardIDU16只读变更广播单板ID
PartNumberString只读变更广播部件编码
PcbVersionString只读变更广播PCB版本号
LogicVersionString只读变更广播逻辑版本号(cpld)
SRVersionString只读变更广播SR版本号
MCUVersionString只读变更广播MCU版本号
PSIPVersionString只读变更广播封装电源版本号
LogicUnitU32只读变更广播逻辑位号(U位号)
PowerWattsU32只读变更广播功率
RunningStatusU8只读变更广播监控cpld和mcu的运行状态(1:正常运行,0:异常)
FruIDU8只读变更广播关联Fru对象的FruID属性
NodeIdString只读变更广播资源id,优先遵循v2中redfish的计算规则,这里由容器信息Position和设备丝印名称DeviceName拼接而成,如:chassisPCIeRiser1
DeviceNameString只读变更广播板卡丝印信息(如:PCIe Riser1)
BoardTypeString只读变更广播单板类型
RefComponentString只读变更广播引用到Component对象
RefFruString只读变更广播引用到Fru对象
SerialNumberString只读变更广播序列号
CpldStatusU8只读变更广播Cpld状态
MultiLogicUnitLogicUnitObject只读变更广播单板所有逻辑位号,key:cpld名,value:逻辑位号
MultiLogicVersionLogicVerObject只读变更广播单板所有逻辑版本号,key:cpld名,value:逻辑版本号

==自定义类型==


LogicUnitObject: 结构体类型

  • key: String
  • value: U32

LogicVerObject: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.Board.CpuBoard

==属性==

属性名类型可读写信号通知描述
PlatformU8只读变更广播平台类型
BIOSVersionString只读变更广播BIOS版本号,一host对应多个bcu的场景下只有主bcu显示

bmc.kepler.Systems.Board.M2

==属性==

属性名类型可读写信号通知描述
M2SlotPresenceU8只读变更广播M.2盘在位情况,每个bit表示一个槽位,bit0表示SSD1在位,bit1表示SSD2在位
M2SlotMaxCountU8只读变更广播M.2盘的上限

bmc.kepler.Systems.Board.NpuBoard

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播NPU模组功耗值,单位W
PowerCapWattsU16只读变更广播NPU模组功耗封顶值,单位W
MaxPowerCapWattsU16只读变更广播NPU模组支持的最大功耗封顶值,单位W
MinPowerCapWattsU16只读变更广播NPU模组支持的最小功耗封顶值,单位W
ModelString只读变更广播NPU模组型号
ComputeCapabilityString只读变更广播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

==属性==

属性名类型可读写信号通知描述
UIDString只读变更广播组件唯一标识
TypeString只读变更广播组件类型(枚举值:EXU,BCU,SEU,CLU,SEU)
HWSRVersionString只读变更广播天池组件Eeprom中的sr版本号
CurrentUpgradeStatusU8只读变更广播0表示未在升级,1:mcu正在升级,2cpld正在升级

bmc.kepler.Systems.BootOptions

==属性==

属性名类型可读写信号通知描述
BootSourceOverrideModeString只读变更广播系统启动模式,Legacy或UEFI
BootSourceOverrideEnabledString只读变更广播系统启动项生效次数:Disabled不生效,Once生效一次,Continuos一直生效
BootSourceOverrideTargetString只读变更广播系统启动项
BootOptionReferenceString[]只读变更广播唯一启动选项标识符
BootOrderString[]只读变更广播系统启动项启动顺序
BootModeSupportBoolean只读变更广播BIOS启动模式是否支持设置
BootModeIpmiSettableBoolean只读变更广播BIOS启动模式是否支持通过IPMI设置
BootOptionPolicyU8读写变更广播定制化启动项策略,0:不定制;1:设置永久启动项联动修改启动顺序,设置的永久启动项不被单次启动项覆盖
PreviousBootSourceOverrideTargetString只读变更广播上次设置的永久启动项类型

==方法==


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

==属性==

属性名类型可读写信号通知描述
FruIdU8只读变更广播关联所在的Fru的Fruid
InstanceU8只读变更广播组件设备Number
TypeU8只读变更广播组件类型
NameString读写变更广播组件设备名称
PresenceU8只读变更广播组件在位情况
HealthU8读写变更广播组件健康状态
PowerStateU8只读变更广播组件上电状态
BoardIdU16只读变更广播组件单板BoardId
UniqueIdString只读变更广播组件唯一标识,Vendor + ComponentID
ManufacturerString只读变更广播组件厂商信息
GroupIdU8只读变更广播组件逻辑组Id
LocationString只读变更广播组件的容器
SerialNumberString只读变更广播组件序列号
PartNumberString只读变更广播组件号
SegmentIdU8只读变更广播组件容器ID
FunctionString只读变更广播部件功能信息
PreviousSNString只读变更广播更换前SN,SerialNumber,来自board区域掉电持久化
ReplaceFlagU8只读变更广播部件是否发生了更换,用于产生SEL日志
NodeIdString只读变更广播节点的ID

==方法==


UpdateHealth

更新组件健康状态

参数

  • Health: U8 - 健康状态

bmc.kepler.Systems.Components

==方法==


GetComponentTypes

获取当前存在的所有对象的部件类型

返回值

  • ComponentTypes: Array - 所有对象的部件类型列表

==自定义类型==


ComponentTypes: 结构体类型

  • ComponentType: U8 - 部件类型
  • ComponentName: String - 部件名称

bmc.kepler.Systems.ComputerSystem

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播系统Id
OSVersionString只读变更广播OS版本号
KernelVersionString只读变更广播内核版本号
HostNameString读写变更广播主机名称
DomainNameString只读变更广播域名称
HostDescriptionString只读变更广播计算机描述
MajorOSVersionString只读变更广播操作系统主版本号
MinorOSVersionString只读变更广播操作系统次版本号
HostnameSyncEnabledBoolean读写变更广播从带内同步hostname到BMC使能开关默认true

bmc.kepler.Systems.ComputerSystem.Metrics

==属性==

属性名类型可读写信号通知描述
TotalSystemMemoryGiBDouble只读变更广播总系统内存容量
SystemMemoryBuffersGiBDouble只读变更广播系统内存缓冲区容量
SystemMemoryCachedGiBDouble只读变更广播系统内存缓存区容量
NetBandwidthThresholdPercentU16读写变更广播网络带宽占用率门限默认值100

bmc.kepler.Systems.Contact

==属性==

属性名类型可读写信号通知描述
OfficalWebString读写变更广播官网
SupportWebString读写变更广播技术支持网站
EmailString读写变更广播邮箱
PhoneString读写变更广播电话
CopyrightString读写变更广播版权
KVMClientDownloadLinkString读写变更广播独立kvm客户端下载连接信息
QRCodeSupportedBoolean读写变更广播Web是否支持显示文档二维码标志位

bmc.kepler.Systems.ContainedPort

==属性==

属性名类型可读写信号通知描述
NodeIdString只读变更广播包含物理网口ID

bmc.kepler.Systems.CoolingArea

==属性==

属性名类型可读写信号通知描述
AreaIdU8只读变更广播调速域Id
RequirementIdxU8只读变更广播目标调速策略Id
PolicyIdxGroupU8[]只读变更广播线性调速策略Id组
FanIdxGroupU8[]只读变更广播调速域风扇组

bmc.kepler.Systems.CoolingConfig

==属性==

属性名类型可读写信号通知描述
SmartCoolingStateString只读变更广播智能调速使能状态
SmartCoolingModeString只读变更广播智能调速模式
MediumString只读变更广播散热介质(风/液/风液混合)
CtrlModeString只读变更广播冷却单元的控制模式(自动/手动/混合)
TimeOutU32只读变更广播手动模式下的风扇超时时间
ManualLevelU8只读变更广播手动模式下的风扇转速级别
LevelPercentRangeU8[]只读变更广播手动设置转速级别允许范围
SensorLocationSupportedBoolean只读变更广播是否支持温度海洋界面显示
MinAllowedFanSpeedPercentU8读写变更广播失联状态场景风扇转速级别
MixedModeSupportedBoolean只读变更广播是否支持混合模式场景,true:支持混合模式,false:不支持混合模式

==方法==


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:未触发异常调速

SetMinPWM

设置转速下限值

参数

  • DeviceType: String - 散热设备类型
  • DeviceIds: U8[] - 散热设备Id数组
  • DeviceSpeeds: U8[] - 散热设备转速数组

GetComponentThermalZone

获取指定温度点器件类型与散热器件对应关系

参数

  • ComponentType: String - 温度器件类型

返回值

  • ComponentThermalZone: Array - 指定温度器件对应散热器件数组

==自定义类型==


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 - 目标温度调速温度值的最大值

ComponentThermalZone: 结构体类型

  • Slot: U8 - 器件id
  • FanIds: U8[] - 器件对应风扇id
  • PumpIds: U8[] - 器件对应泵id

bmc.kepler.Systems.CoolingFan

==属性==

属性名类型可读写信号通知描述
FanIdU8只读变更广播风扇Id
HardwarePWMDouble只读变更广播风扇硬件占空比
FrontPresenceU8只读变更广播前转子在位状态
RearPresenceU8只读变更广播后转子在位状态
FrontStatusU8只读变更广播风扇前转子状态
RearStatusU8只读变更广播风扇后转子状态
FrontSpeedU16只读变更广播前转子转速
RearSpeedU16只读变更广播后转子转速
LevelU8只读变更广播风扇转速级别
ManualSpeedPercentResetPersistU8只读变更广播复位持久化的手动模式下的转速级别
ManualSpeedPercentPoweroffPersistU8只读变更广播掉电持久化的手动模式下的转速级别

bmc.kepler.Systems.CoolingPolicy

==属性==

属性名类型可读写信号通知描述
PolicyIdxU8只读变更广播线性调速策略ID
PolicyTypeU32只读变更广播Policy类型,用于标识特定Policy对象
IsValidU8只读变更广播策略是否生效,1生效,0不生效
ExpCondValString只读变更广播预期生效条件
ActualCondValString只读变更广播实际生效条件
CustomSupportedBoolean只读变更广播是否支持自定义调速曲线
FanSpeedRangePercentsU8[]只读变更广播自定义调速曲线风扇速度范围
HysteresisU8只读变更广播迟滞量
TemperatureRangeLowS16[]只读变更广播线性调速策略温度区间左值
TemperatureRangeHighS16[]只读变更广播线性调速策略温度区间右值
SpeedRangeLowS16[]只读变更广播线性调速策略转速区间左值
SpeedRangeHighS16[]只读变更广播线性调速策略温度区间右值

==方法==


SetCustomCoolingPolicy

设置自定义调速策略

参数

  • TemperatureArray: U8[] - 温度数组
  • FanSpeedArray: U8[] - 风扇速度数组

SetHysteresis

设置迟滞量

参数

  • Hysteresis: U8 - 迟滞量

bmc.kepler.Systems.CoolingPump

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播泵Id
SlotU8只读变更广播泵槽位号
ActualPWMDouble只读变更广播泵占空比
SpeedU16只读变更广播泵转速
PresenceU8只读变更广播泵在位状态
StatusU8只读变更广播泵状态
LevelU8只读变更广播手动模式下的转速级别

bmc.kepler.Systems.CoolingRequirement

==属性==

属性名类型可读写信号通知描述
RequirementIdU64只读变更广播目标调速策略Id
TemperatureTypeU32只读变更广播温度点类型
ActiveInStandbyBoolean只读变更广播Standby下调速是否生效
TargetTemperatureCelsiusU8只读变更广播目标调速的目标值
MaxAllowedTemperatureCelsiusU8只读变更广播最大允许的工作温度,即满转温度
CustomSupportedBoolean只读变更广播是否支持自定义目标温度值
CustomTargetTemperatureCelsiusU8只读变更广播用户自定义温度值
TargetTemperatureRangeCelsiusU8[]只读变更广播自定义温度允许范围
MonitoringStatusU8只读变更广播温度点状态 0正常 1异常
MonitoringValueDouble只读变更广播温度点状态
FailedValueU64只读变更广播温度点失效调速值
ThresholdValueU8[]只读变更广播温度点告警阈值
AlarmSpeedU8[]只读变更广播告警调速策略
SmartCoolingTargetTemperatureCelsiusS16[]读写变更广播SmartCooling目标值数组
SensorNameString只读变更广播目标调速策略关联的传感器名称

==方法==


SetTargetTemperature

自定义目标温度

参数

  • TemperatureCelsius: U8 - 目标温度值

SetBackupTemperatureCelsius

设置备用温度点温度值

参数

  • TemperatureCelsius: Double - 目标温度值

SetBackupTemperatureStatus

设置备用温度点状态

参数

  • Status: U8 - 目标温度值

SetMaxAllowedTemperature

设置全速阈值

参数

  • MaxAllowedTemperature: U8 - 全速阈值

SetFailedValue

设置温度失效转速

参数

  • FailedValue: U64 - 温度失效转速

SetSmartCoolingTargetTemperature

设置SmartCooling目标值数组

参数

  • SmartCoolingTargetTemperature: S16[] - SmartCooling目标值数组

SetBasicCoolingTargetTemperature

设置目标温度

参数

  • BasicCoolingTargetTemperature: U8 - 目标温度值

bmc.kepler.Systems.DPUCard

==属性==

属性名类型可读写信号通知描述
BootSourceOverrideModeU8只读变更广播系统启动项0:未设置1:PXE启动2:本地磁盘启动
PxeOptionString读写变更广播DPU卡的PXE启动选项
UUIDString只读变更广播DPU卡的UUID
StorageIpAddrString只读变更广播存储管理网口IP地址
StorageIpVlanU16只读变更广播存储管理网口VlanID
M2SlotMaxCountU8只读变更广播M.2卡的上限
M2SlotPresenceU8只读变更广播M.2卡在位情况,每个bit表示一个槽位
NetworkAdapterMaxCountU8只读变更广播网卡最大数量
NetworkAdapterPresenceU8只读变更广播网卡在位情况,每个bit表示一张
MCUVersionString只读变更广播MCU版本号
SRVersionString只读变更广播SR版本号
UIDString只读变更广播组件唯一标识
PfMacInfoArray只读变更广播扩展卡的Physical Function Port信息、Physical Function Id信息和永久物理地址信息
BootSourceOverrideEnabledU8只读变更广播系统启动固化选项,0:单次生效1:永久生效
ModelString只读变更广播DPU卡名称,如IT21SHSK
SystemLoadedStatusEnum只读变更广播DPU卡的OS启动状态
MRCLogLevelU8读写变更广播DPU卡BIOS MRC日志等级
UEFILogLevelU8读写变更广播DPU卡BIOS UEFI日志等级
LogicVersionString只读变更广播Cpld版本
PowerStateString只读变更广播DPU卡电源状态,On表示上电,Off表示下电
VrdVersionString只读变更广播VRD版本号
MPUBusyStatusU8读写变更广播MPU繁忙状态 0: 空闲 1: 繁忙
OSSupportedBoolean只读变更广播用来识别是否开启与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

SystemBootStatus: 枚举类型

  • 0: OSBootNotStarted
  • 1: OSBootStarting
  • 2: OSBootFailed
  • 3: OSBootCompleted
  • 4: OSBootTimeout
  • 5: NoBootableDevice

bmc.kepler.Systems.DPUCard.Fault

==属性==

属性名类型可读写信号通知描述
HeartBeatLossU8只读变更广播是否发生心跳丢失

bmc.kepler.Systems.DPUCard.Metrics

==属性==

属性名类型可读写信号通知描述
CPUTemperatureCelsiusS16只读变更广播SDI卡CPU温度(单位摄氏度,精度为1摄氏度,有小数点则四舍五入。)
SFP1TemperatureCelsiusS16只读变更广播光模块1温度
SFP2TemperatureCelsiusS16只读变更广播光模块2温度
Inlet1TemperatureCelsiusS16只读变更广播计算卡进风口温度
Outlet1TemperatureCelsiusS16只读变更广播计算卡出风口温度
PowerWattsU16只读变更广播功率
NetworkAdapterChipTemperatureCelsiusS16只读变更广播DPU Nic温度

bmc.kepler.Systems.DPUCard.Processor

==属性==

属性名类型可读写信号通知描述
ArchitectureString只读变更广播DPU 的CPU架构
TotalCoresU8只读变更广播DPU 的CPU核数

bmc.kepler.Systems.DPUCard.System

==属性==

属性名类型可读写信号通知描述
BIOSVersionString只读变更广播板卡的BIOS版本号
BiosBootStageEnum只读变更广播DPU卡的BIOS启动状态
MemorySizeGiBU16只读变更广播DPU内存大小
DiskCapacityGiBU16只读变更广播DPU存储大小
SecureBootOptionEnabledBoolean读写变更广播是否开启安全启动项

==自定义类型==


BiosBootStatus: 枚举类型

  • 0: BiosBootNotStarted
  • 1: BiosBootStarting
  • 2: BiosBootCompleted
  • 3: BiosBootTimeout

bmc.kepler.Systems.DataAcquisitionService

==属性==

属性名类型可读写信号通知描述
EnabledU8读写变更广播数据采集开关使能状态

==方法==


GetHistoryData

根据Component、MetricType、时间筛选Tag、Metric、DataPoint表信息

参数

  • Component: String - 采集主体名称
  • MetricType: String - 采集类型
  • StartTime: U64 - 开始时间
  • EndTime: U64 - 结束时间

返回值

  • Data: String - 数据采集信息

ClearHistoryData

清除采集到的数据

返回值

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

bmc.kepler.Systems.DelayedPowerOnPolicy

==属性==

属性名类型可读写信号通知描述
ModeString读写变更广播延迟上电策略
SecondsDouble读写变更广播延迟上电时间

bmc.kepler.Systems.DiscreteEvent

==属性==

属性名类型可读写信号通知描述
PropertyU32只读变更广播离散事件监听的属性,如果监听类型是组合侦听则代表 IPMI SEL产生使用的数据和方向
EventDirU8只读变更广播离散事件产生的方向:0 - 恢复;其他 - 产生,当监听类型是独立侦听时使用
SensorObjectString只读变更广播离散事件关联的离散传感器,当IPMI SEL产生或者恢复时体现在当前传感器的健康状态以及SEL上

bmc.kepler.Systems.DiscreteSensor

==属性==

属性名类型可读写信号通知描述
EntityIdU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Id
EntityInstanceU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Instance
OwnerIdU8只读变更广播传感器归属标识,默认32(归属于BMC),来自于IPMI规范,具体可以参考规范 43.1
OwnerLunU8只读变更广播传感器的Lun,默认0,来自于IPMI规范,具体可以参考规范 43.1
CapabilitiesU8只读变更广播传感器支持能力,来自于IPMI规范,具体可以参考规范 43.1
SensorIdentifierString只读变更广播传感器标识
SensorNameString只读变更广播传感器对外显示的名称
PositiveHysteresisU8只读变更广播传感器正向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
NegativeHysteresisU8只读变更广播传感器负向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
SensorNumberU8只读变更广播传感器编号,默认255,来自于IPMI规范,由BMC自行生成;如果需要特殊的编号,则需要单独在传感器定制化进行定制(BMC正常运行时插入的部件的传感器不支持定制)
ReadingU16只读变更广播传感器原始读值,引用传感器的数据源(如Scanner)读值同步,需要填写一个默认值,用于数据源未更新时显示,需要注意在门限之内,防止产生SEL事件

bmc.kepler.Systems.DiscreteSensorDisplay

==属性==

属性名类型可读写信号通知描述
StatusString只读变更广播传感器当前状态:Enabled:传感器使能;Disabled:传感器禁用;InTest:传感器测试中;Starting:传感器更新中
HealthString只读变更广播传感器健康状态:Critical:紧急;Major:严重;Minor:一般;OK:正常
AssertStatusU16只读变更广播传感器SEL事件状态,bit0 - bit14依次对应15种offset的离散事件状态,1:Assert;0:Deassert

bmc.kepler.Systems.DiskCoolingConfig

==属性==

属性名类型可读写信号通知描述
DiskRowTemperatureAvailableBoolean只读变更广播背板上硬盘温度是否能正常获取
SysHDDsMaxTemperatureDouble只读变更广播HDD硬盘最大温度, 单位:摄氏度
SysSSDsMaxTemperatureDouble只读变更广播SSD硬盘最大温度(仅SAS/SATA), 单位:摄氏度
SysM2sMaxTemperatureDouble只读变更广播M.2硬盘最大温度, 单位:摄氏度
SysAllSSDsMaxTemperatureDouble只读变更广播所有SDD介质硬盘的最大温度, 单位:摄氏度

bmc.kepler.Systems.EnergyEfficiencyOptimization

==属性==

属性名类型可读写信号通知描述
ModeString读写变更广播智能节能模式
BusinessLoadString读写变更广播业务负载

==方法==


SetConfiguration

保存节能配置

参数

  • BusinessLoad: String - 业务负载
  • Configuration: String - 节能配置

bmc.kepler.Systems.EnergyMetric

==属性==

属性名类型可读写信号通知描述
SystemPowerU32只读变更广播系统总输入功率(单位W)
SystemOutputPowerU32只读变更广播系统总输出功率(单位W)
HighPowerThresholdWattsDouble只读变更广播电源功率过高告警门限
PowerConsumptionDouble只读变更广播累计耗电量(单位Kw*h)
MaxConsumedWattsU32只读变更广播峰值功率(系统最大功率,单位W)
MaxConsumedOccurredTimeU32只读变更广播峰值功率出现时间(时间戳)
MinConsumedWattsU32只读变更广播系统最小功率(单位W)
StatisticsCollectedTimeU32只读变更广播开始统计时间(时间戳)
AverageConsumedWattsU32只读变更广播系统平均功率(单位W)
HeatKcalU32只读变更广播系统电源消耗热量(单位Kcal),由累计耗电量乘以860.42并舍去小数部分
EnergySavedPercentU8只读变更广播省电百分比
EnergySavedKwhDouble只读变更广播省电总量KWh
CarbonEmissionsReducedKgDouble只读变更广播减少碳排量(单位千克)
FanTotalPowerWattsU32只读变更广播风扇总功耗(单位瓦特)
PredictedPowerSavedKwhDouble只读变更广播开启节能功能后预计节省功耗
PredictedPowerSavedPercentDouble只读变更广播开启节能功能后预计节省功耗百分比
TotalPowerSavedKwhDouble只读变更广播累计节省功耗
TotalPowerSavedPercentDouble只读变更广播累计节省功耗百分比
PowerPredictStatusU8只读变更广播功耗预测模型状态
PowerPredictDescriptionString只读变更广播功耗预测工作状态描述
HistoryPowerAverageWattsU32只读变更广播节能特性开启前平均功率
MinPowerWattsU32只读变更广播服务器的最小功耗
MaxPowerWattsU32只读变更广播服务器的最大功耗

==方法==


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

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播Entity Id,IPMI 规范 43.14
InstanceU8只读变更广播Entity Instance,IPMI 规范 43.1中描述Instance配置,默认值 96
SlotU8只读变更广播Entity所在的槽位号,默认 255
NameString只读变更广播Entity的名称
PowerStateU8只读变更广播Entity的上下电状态,关联对应的上下电信号来源
PresenceU8只读变更广播Entity的在位状态,关联对应的在位信号来源
HealthU8只读变更广播Entity的健康状态,不需要配置,默认值 0

bmc.kepler.Systems.EventSummary

==属性==

属性名类型可读写信号通知描述
MinorCountU32只读变更广播当前system的一般事件的汇总数量
MajorCountU32只读变更广播当前system的严重事件的汇总数量
CriticalCountU32只读变更广播当前system的紧急事件的汇总数量

bmc.kepler.Systems.Events

==属性==

属性名类型可读写信号通知描述
HealthString只读变更广播系统健康状态,取值有0:Normal,1:Minor,2:Major,3:Critical
EventRecordSeqU64只读变更广播事件记录标识,随着事件产生递增
CriticalCountU32只读变更广播致命告警数量
MajorCountU32只读变更广播严重告警数量
MinorCountU32只读变更广播一般告警数量
VersionString只读变更广播当前事件配置的版本
CurEventCountU32只读变更广播当前事件数量
MaxEventCountU32只读变更广播最大事件数量
DumpRecordU64只读变更广播SEL日志转储的总量,每次转储均会累加
MajorVersionString只读变更广播告警语言配置的主版本
MinorVersionString只读变更广播告警语言配置的次要版本
AuxVersionString只读变更广播告警语言配置的辅助版本
EventModeU8读写变更广播事件的记录模式,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

==属性==

属性名类型可读写信号通知描述
CaterrDiagnoseResultU8只读变更广播根据CATERR诊断结果触发对应事件
LocalSystemIdU8只读变更广播故障所在系统的物理编号,主系统编号0,同一个主系统内的子系统依次编号,从1开始

==方法==


DumpProcessorLog

宕机收集

参数

  • LogType: String - 宕机收集支持的类型,当前只支持RAS,预留扩展ALL、RAS
  • Path: String - 宕机收集的文件路径,指定目录/tmp或缺省,缺省情况下目录是/tmp

返回值

  • TaskId: U32 - Dump Processor Log Task Id

bmc.kepler.Systems.FDMDomain.CPURAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播CPU所在的系统的Id
LogicalIdU8只读变更广播CPU逻辑Id
BISTFailedU8只读变更广播内建自检失败
CorrectableErrorU8只读变更广播CPU关键模块发生的可纠正错误, 取值: 0-未发生,1-发生
UncorrectableErrorU8只读变更广播CPU关键模块发生的不可纠正错误, 取值: 0-未发生,1-发生
IsolatedU8只读变更广播故障CPU被隔离
CoreIsolatedU8只读变更广播CPU核隔离
IsolatedCoreIdString只读变更广播CPU核隔离的核id
ConfigErrorTypeU8只读变更广播配置错误类型
ConfigErrorCodeString只读变更广播配置错误具体错误码(十六进制字符串格式)
ModelMismatchedU8只读变更广播CPU型号不匹配
FirmwareMismatchedU8只读变更广播固件不匹配
InterConnectionLaneFaultU8只读变更广播CPU互联链路异常
InterConnectionLaneErrorMaskU8只读变更广播CPU互联总线(HCCS)故障Lane编号/位图,举例:bit0:Lane0;bit1:Lane1
CacheWayErrorMaskU8只读变更广播CacheWay异常状态,0表示正常,bit位:0表示L1,1表示L2,2表示L3
CurrentPeriodCacheUncorrectableECCErrorCountU32只读变更广播统计CPU Cache模块运行周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。系统上下电/复位/更换部件时,统计次数清零。
LifeTimeCacheUncorrectableECCErrorCountU32只读变更广播统计CPU Cache模块生命周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。更换部件时,统计次数清零。

bmc.kepler.Systems.FDMDomain.MemoryOnChipRAS

==属性==

属性名类型可读写信号通知描述
CorrectableECCU8只读变更广播MemoryOnChip发生可纠正错误, 取值: 0-未发生,1-发生
UncorrectableECCU8只读变更广播MemoryOnChip发生不可纠正错误发生, 取值:0-未发生,1-发生
ScrubingUncorrectableECCU8只读变更广播MemoryOnChip发生巡检UCE错误, 取值:0-未发生,1-发生
ParityErrorU8只读变更广播MemoryOnChip发生奇偶校验错误, 取值:0-未发生,1-发生
CorrectableECCStormU8只读变更广播MemoryOnChip发生CE风暴错误, 取值:0-未发生,1-发生
CorrectableECCOverflowU8只读变更广播MemoryOnChip发生CE漏斗溢出错误, 取值:0-未发生,1-发生
IsolationStatusU8只读变更广播内存隔离自愈执行状态,取值范围:0(未执行隔离)、1(已成功执行隔离)、其他(预留)。系统上下电/复位时,恢复到未执行隔离状态。

bmc.kepler.Systems.FDMDomain.MemoryRAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播内存所在系统的id
NameString只读变更广播内存对象名称
LogicalCpuIdU8只读变更广播内存所属的CPU id
LogicalChannelIdU8只读变更广播内存所属逻辑通道id
DimmIdU8只读变更广播内存对应Dimm条id
PredictiveFaultU8只读变更广播硬件预故障
ConfigErrorTypeU8只读变更广播配置错误类型
ConfigErrorCodeString只读变更广播配置错误具体错误码(十六进制字符串格式)
ScrubingUncorrectableECCU8只读变更广播内存发生巡检UCE错误, 取值:0-未发生,1-发生
ParityErrorU8只读变更广播内存发生奇偶校验错误, 取值:0-未发生,1-发生
UncorrectableECCErrorU8只读变更广播不可纠正错误发生
CorrectableECCErrorU8只读变更广播多次发生可纠正错误导致CE统计超门限
CorrectableECCU8只读变更广播内存发生可纠正错误, 取值: 0-未发生,1-发生
PoorContactFaultU8只读变更广播内存接触类故障,0:无故障;1:有故障
LastPredictTimeU32只读变更广播上一次内存产生故障时间
HealthScoreU8只读变更广播健康分数
LastIsolationStatusU8只读变更广播上一次内存隔离状态
ErrorStormCountU32只读变更广播内存条的CE风暴次数
CorrectableECCStormU8只读变更广播内存发生CE风暴, 取值: 0-未发生,1-非定制规则下发生CE风暴,其他-定制规则下发生CE风暴
CorrectableECCOverflowU8只读变更广播内存发生CE漏斗溢出, 取值: 0-未发生,其他-发生
CurrentPeriodUncorrectableECCErrorCountU32只读变更广播统计内存运行周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。系统上下电/复位/更换部件时,统计次数清零。
LifeTimeUncorrectableECCErrorCountU32只读变更广播统计内存生命周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。更换部件时,统计次数清零。
CorrectableECCStormBurstCountU32只读变更广播统计内存发生超级CE风暴的次数,取值范围:0~0xFFFFFFFF。系统下电/复位时,统计次数清零。
DataPoisonedU8只读变更广播内存检测到Data Poisoning。从0到1表示故障事件发生,从1到0不表示故障事件恢复。
CorrectableECCOverfrequencyCountU32只读变更广播系统运行期间,内存CE故障发生频率超门限的次数。取值范围:0~0xFFFFFFFF。系统上下电/复位时,统计次数清零。

bmc.kepler.Systems.FDMDomain.NPURAS

==属性==

属性名类型可读写信号通知描述
CarrierBoardIdU8只读变更广播NPU载板Id
NPUIndexU8只读变更广播实体NPU编号
DieIndexU8只读变更广播NPU内die编号
PredictiveFaultU8只读变更广播硬件预故障标志位,默认值0,异常状况置1
DiagnosticFaultU8只读变更广播FDM诊断发现故障的标志位,默认值0,异常状况置1
InterConnectionLaneErrorBitmapU32只读变更广播NPU互联总线(HCCS)故障macro编号/位图, bit0对应macro0, 以此类推。其中0表示正常, 1表示异常

bmc.kepler.Systems.FDMDomain.PCIeRASCollector

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误, 取值: 0-未发生, 1-发生
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误, 取值: 0-未发生,1-发生
FatalErrorU8只读变更广播PCIe设备发生致命错误, 取值: 0-未发生,1-发生
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误, 取值: 0-未发生,1-发生
SystemErrorU8只读变更广播PCIe设备发生系统错误, 取值: 0-未发生,1-发生
BandwidthReductionU8只读变更广播PCIe降带宽检事件的上报属性
LinkSpeedReducedU8只读变更广播PCIe设备降速率检测告警上报事件属性
DevSegmentU8只读变更广播事件对应PCIe设备的Segment
DevBusU8只读变更广播事件对应PCIe设备的Bus
DevDeviceU8只读变更广播事件对应PCIe设备的Device
DevFunctionU8只读变更广播事件对应PCIe设备的Function

bmc.kepler.Systems.FDMDomain.SystemRAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
NoMemoryDetectedInPOSTU8只读变更广播POST阶段检测不到内存
MemoryConfigErrorTypeU8只读变更广播系统内存配置错误类型
MemoryConfigErrorCodeString只读变更广播系统内存配置错误具体错误码(十六进制字符串格式)

bmc.kepler.Systems.FDMDomain.UnknownPCIeRASCollector

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误,取值: 0-未发生,1-发生,默认值0。
CorrectableErrorStormU8只读变更广播PCIe设备发生可纠正错误风暴,取值: 0-未发生,1-发生,默认值0。
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误,取值: 0-未发生,1-发生,默认值0。
FatalErrorU8只读变更广播PCIe设备发生致命错误,取值: 0-未发生,1-发生,默认值0。
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误,取值: 0-未发生,1-发生,默认值0。
SystemErrorU8只读变更广播PCIe设备发生系统错误,取值: 0-未发生,1-发生,默认值0。
BandwidthReductionU8只读变更广播PCIe设备发生降带宽事件,取值: 0-未发生,1-发生,默认值0。
LinkSpeedReducedU8只读变更广播PCIe设备发生降速率事件,取值: 0-未发生,1-发生,默认值0。
DevSegmentU8只读变更广播PCIe设备的root port Segment,默认值:255。发生错误的PCIe设备Segment号,随错误上报赋值。
DevBusU8只读变更广播PCIe设备的root port Bus,默认值:255。发生错误的PCIe设备Bus号,随错误上报赋值。
DevDeviceU8只读变更广播PCIe设备的root port Device,默认值:255。发生错误的PCIe设备Device号,随错误上报赋值。
DevFunctionU8只读变更广播PCIe设备的root port Function,默认值:255。发生错误的PCIe设备Function号,随错误上报赋值。

bmc.kepler.Systems.FDMService

==属性==

属性名类型可读写信号通知描述
UnknownCaterrPolicyString读写变更广播FDM CATERR诊断失败处理策略。NoAction:不做任何处理;Reset:热复位;PowerOff:下电
IdentifiedCaterrPolicyString读写变更广播FDM CATERR诊断成功处理策略。NoAction:不做任何处理;Reset:热复位
MemFaultIsolationModeString读写变更广播设置内存故障隔离总开关状态
MemPoorContactAlarmEnabledBoolean读写变更广播内存DQ线接触不良(poor contact)告警功能开关
MemFaultIsolationEnabledBoolean只读变更广播内存故障隔离总开关,仅有总开关开启时,其他隔离功能才能生效
MemPageOfflineEnabledBoolean读写变更广播内存页隔离(PageOffline)容错功能开关
MemADDDCEnabledBoolean读写变更广播内存自适应双设备数据校正(Adaptive Double DRAM Device Correction, ADDDC)容错功能开关
MemSoftPPREnabledBoolean读写变更广播内存软后包修复(soft post package repair, sPPR)容错功能开关
MemHardPPREnabledBoolean读写变更广播内存硬后包修复(hard post package repair, hPPR)容错功能开关
MemACLSEnabledBoolean读写变更广播内存单比特纠错算法(ACLS)容错功能开关
MaxMemPageOfflineCountU32读写变更广播PageOffline容错能力上限值
MemHardFailureDetectionModeString读写变更广播内存硬失效模式判断方式。PatrolScrub:巡检识别硬失效模式;ExpertRule:规则识别硬失效模式
MemFaultPredictionEnabledBoolean读写变更广播内存故障预测开关状态
MemFaultPredictionModeString读写变更广播内存故障预测模式, ExpertRule(专家规则模式)
HbmFPCEnabledBoolean读写变更广播CPU HBM FPC总开关
HbmACLSEnabledBoolean读写变更广播CPU HBM ACLS开关
HbmSoftPPREnabledBoolean读写变更广播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

==属性==

属性名类型可读写信号通知描述
FanIdU16只读变更广播风扇ID
SlotU8只读变更广播风扇槽位
TypeU8只读变更广播风扇类型
ModelString只读变更广播风扇型号
CoefficientU8只读变更广播风扇转速系数
FanHealthU8只读变更广播风扇健康状态
FanEntityString只读变更广播风扇实体
FrontPresenceU8读写变更广播前转子在位状态
RearPresenceU8读写变更广播后转子在位状态
FrontSpeedU16读写变更广播前转子转速
RearSpeedU16读写变更广播后转子转速
FrontStatusU8只读变更广播前转子状态
RearStatusU8只读变更广播后转子状态
FrontRPMU16只读变更广播前转子转速
RearRPMU16只读变更广播后转子转速
HardwarePWMDouble读写变更广播硬件占空比
PWMPercentageU32只读变更广播占空比
ExpectedPWMDouble读写变更广播预期占空比
FanAlarmLedU8只读变更广播风扇告警
BOMString只读变更广播BOM编码
SystemIdU8只读变更广播系统Id
MaxSupportedPWMU32只读变更广播支持的最大转速
IdentifySpeedLevelU8只读变更广播识别风速级别
PartNumberString只读变更广播部件编码
FrontMaxSpeedU32只读变更广播前转子最大转速
RearMaxSpeedU32只读变更广播后转子最大转速
IsTwinsBoolean只读变更广播是否为双转子
PositionString只读变更广播容器信息
SpeedStableBoolean只读变更广播风扇转速是否稳定(true:稳定,false:不稳定),期望转速与实际转速比相差25%以内为稳定
FunctionDescString只读变更广播功能描述
DeviceNameString只读变更广播部件名称

==方法==


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

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播风扇型号名
IndexU8只读变更广播风扇型号索引
IsDefaultTypeBoolean只读变更广播是否为默认风扇型号
IsTwinsBoolean只读变更广播是否为双转子
FrontMaxSpeedU32只读变更广播前转子最大转速
RearMaxSpeedU32只读变更广播后转子最大转速
IdentifyRangeLowU32只读变更广播风扇型号识别转速左区间
IdentifyRangeHighU32只读变更广播风扇型号识别转速右区间
MatchedCountU8只读变更广播识别风扇数量
PartNumberString只读变更广播部件编码
BOMString只读变更广播BOM编码
SystemIdU8只读变更广播系统Id
SpeedRangeU8[]只读变更广播风扇转速和功率映射关系的风扇转速数组
PowerRangeU16[]只读变更广播风扇转速和功率映射关系的功率数组
FanDiameterMmU16只读变更广播风扇组件的直径,单位毫米

bmc.kepler.Systems.Fans

==属性==

属性名类型可读写信号通知描述
WorkInStandbyU8只读变更广播standby下风扇是否可以运转, 1:可以,0:不可以
EstimatedTotalPowerWattsU16只读变更广播估算的整机风扇总功耗

==方法==


SetPWM

设置所有风扇转速

参数

  • PWM: Double[] - 风扇转速占空比数组

返回值

  • Result: U8 - 返回结果,0:设置成功;1:设置失败

bmc.kepler.Systems.Fru

==属性==

属性名类型可读写信号通知描述
PcbIdU8只读变更广播PcbId, 需要关联到硬件, 从硬件读取Id
PcbVersionString只读变更广播PCB版本, 根据PcbId的值进行计算得出
FruIdU8只读变更广播FruId
FruNameString只读变更广播Fru名称
PowerStateU8只读变更广播Fru的热插拔状态
HealthU8只读变更广播健康状态
EepStatusU8只读变更广播EEPROM状态
GroupPositionString只读变更广播FRU的位置信息, 来自自发现的Position属性, 该属性用于确定FruId
TypeU8只读变更广播FRU类型,TYPE值请参照IPD Lite的BMC IPMI接口说明附录
FruDataIdString只读变更广播关联frudata对象名
BoardIdU16只读变更广播非天池:组件单板BoardID
UniqueIdString只读变更广播天池:组件唯一标识,Vendor + ComponentID
ConnectorGroupIdU32只读变更广播关联Connector传过来的GroupId

bmc.kepler.Systems.FruCtrl

==属性==

属性名类型可读写信号通知描述
PowerStateString只读变更广播反映实时电源状态
SysResetDetectedU8只读变更广播系统复位信号
FruTypeString只读变更广播上下电的Fru类型信息:host、NP加速卡、交换mesh卡
CurrentRestartCauseString只读变更广播用于记录业务系统本次复位原因
CurrentRestartCauseIdU8只读变更广播与CurrentRestartCause对应id
CurrentRestartTypeU8只读变更广播当前系统复位类型,取值0:Initiated by power up,1:Initiated by hard reset, 2:Initiated by warm reset
RestartCauseRecordsString[]只读变更广播用于记录业务系统历史复位原因,最多纪录10次
RestartCountU8只读变更广播用于纪记录业务系统复位次数
PowerOnStrategyString读写变更广播通电开机策略
PowerOnStrategyExceptionsU32读写变更广播殊通电开机策略,1为不执行此次通电开机策略,0为清除策略
PanelPowerButtonEnabledBoolean读写变更广播面板按钮使能true,不屏蔽为false
GracefulShutdownTimeoutEnabledU32读写变更广播安全下电时限使能开关
GracefulShutdownTimeoutSecondsU32读写变更广播安全下电超时时间,超时后执行强制下电
GracefulShutdownDefaultTimeoutSecondsU32只读变更广播安全下电默认超时时间,关联CSR
GracefulShutdownMaxTimeoutSecondsU32只读变更广播安全下电超时时间上限,关联CSR
GracefulShutdownMinTimeoutSecondsU32只读变更广播安全下电超时时间上限,关联CSR
HotswapStateString只读变更广播上下电流程中内部状态机流转产生,需要通知到事件
LastPowerEventU8只读变更广播仅对上电做事件记录复位持久化
PowerCtrlFaultU8只读变更广播判断上一次上电是否上电成功,或下电命令是否下电成功复位持久化
PowerCycleTypeU8只读变更广播0: 无power cycle任务;1: 有power cycle任务;2: 有force power cycle任务
PreviousPowerStateString只读变更广播表示上次通电状态 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

==属性==

属性名类型可读写信号通知描述
MfgDateString只读变更广播生产日期
BoardManufacturerString只读变更广播单板生产厂商默认Huawei
BoardProductNameString只读变更广播单板产品名称
BoardSerialNumberString只读变更广播单板系列化编号
BoardPartNumberString只读变更广播单板部件号
BoardFRUFileIDString只读变更广播单板FRufileID
BoardCustomInfoString只读变更广播单板自定义信息

bmc.kepler.Systems.FruData.Chassis

==属性==

属性名类型可读写信号通知描述
ChassisTypeString只读变更广播关联的Chassis类型
ChassisPartNumberString只读变更广播关联的Chassis部件号
ChassisSerialNumberString只读变更广播关联的Chassis序列号
ChassisCustomInfoString只读变更广播关联的Chassis扩展域

bmc.kepler.Systems.FruData.Overview

==属性==

属性名类型可读写信号通知描述
FruIdU8只读变更广播关联所在的Fru的Fruid
FruTypeString只读变更广播关联所在的Fru的类型
FruNameString只读变更广播关联所在的Fru的名字

bmc.kepler.Systems.FruData.Product

==属性==

属性名类型可读写信号通知描述
ManufacturerNameString只读变更广播制造商名称
ProductNameString只读变更广播产品名,由整机测写入
ProductPartNumberString只读变更广播产品部件号
ProductVersionString只读变更广播产品网元类型/版本号,由产品软件定义
ProductSerialNumberString只读变更广播产品序列号
AssetTagString只读变更广播客户资产号,由客户定义
ProductFRUFileIDString只读变更广播产品fru编号
ProductCustomInfoString只读变更广播产品定制信息

bmc.kepler.Systems.FruData.System

==属性==

属性名类型可读写信号通知描述
SystemManufacturerString只读变更广播系统制造商
SystemProductNameString只读变更广播系统产品名称
SystemVersionString只读变更广播系统版本
SystemSerialNumberString只读变更广播系统序列号

bmc.kepler.Systems.Frus

bmc.kepler.Systems.HBM

==属性==

属性名类型可读写信号通知描述
LogicTemperatureCelsiusDouble只读变更广播HBM Logic区域温度
DRAMTemperatureCelsiusDouble只读变更广播HBM DRAM区域温度

bmc.kepler.Systems.HddBackplane

==属性==

属性名类型可读写信号通知描述
StartSlotU8只读变更广播指定硬盘起始槽位号

bmc.kepler.Systems.HistoryTemperature

==属性==

属性名类型可读写信号通知描述
TemperatureTypeU32只读变更广播温度类型, 1:CPU, 2:出风口, 11:进风口, 0xFFFFFFFF:无效值(默认)
TemperatureNameString只读变更广播温度点名称

==方法==


GetData

获取温度点历史温度数据

返回值

  • RetData: Array - 返回的温度点历史温度数据

ClearData

清空温度点历史温度数据


==自定义类型==


TemperatureDataItem: 结构体类型

  • Time: String - 统计时间
  • InletTempCelsius: S32 - 温度值

bmc.kepler.Systems.IPMIEvent

==属性==

属性名类型可读写信号通知描述
SensorTypeU8只读变更广播IPMI 事件的传感器类型
ReadingTypeU8只读变更广播IPMI 事件的事件读值类型,复位持久化,事件类型来自于HOST侧上报
EventDataU32只读变更广播IPMI 事件的SEL数据,复位持久化,事件数据来自于HOST侧上报或者HOST上下电状态变化感知

bmc.kepler.Systems.IPv4Address

==属性==

属性名类型可读写信号通知描述
AddressString只读变更广播IP地址
SubnetMaskString只读变更广播子网掩码
GatewayString只读变更广播网关
AddressOriginString只读变更广播地址模式

bmc.kepler.Systems.IPv6Address

==属性==

属性名类型可读写信号通知描述
AddressString只读变更广播IP地址
PrefixLengthString只读变更广播前缀长度
AddressStateString只读变更广播地址状态
AddressOriginString只读变更广播地址来源
GatewayString[]只读变更广播网关

bmc.kepler.Systems.Led

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播Led灯的名称
OnDurationU8只读变更广播亮灯持续时间 默认值0
OffDurationU8只读变更广播关灯持续时间 默认值0
CapabilityU8只读变更广播颜色,3:绿色,2:红色
SystemIdU8只读变更广播系统id
StateU8读写变更广播当前Led灯的状态
IdU8只读变更广播每个LED灯都会对应一个固定id
FruIdU8只读变更广播关联的FRU id
ColorCapabilitiesU8只读变更广播Led灯支持的颜色能力
LocalControlStateColorString只读变更广播本地控制模式下的颜色
OverrideStateColorString只读变更广播超驰状态下的颜色
ModeU8只读变更广播Led模式

==方法==


SetState

设置Led灯的状态

参数

  • State: U8 - Led灯的状态
  • Interval: U8 - 闪烁状态持续时长

返回值

  • State: U8 - Led灯的状态
  • OnDuration: U8 - 闪烁状态下亮灯持续时长
  • OffDuration: U8 - 闪烁状态下关灯持续时长

bmc.kepler.Systems.Led.Policy

==属性==

属性名类型可读写信号通知描述
NormalU16[]读写变更广播Normal等级亮灯策略
MinorU16[]读写变更广播Minor等级亮灯策略
MajorU16[]读写变更广播Major等级亮灯策略
CriticalU16[]读写变更广播Critical等级亮灯策略

bmc.kepler.Systems.LiquidCoolingConfig

==属性==

属性名类型可读写信号通知描述
CtrlModeString只读变更广播冷却单元的控制模式(自动/手动/混合)
TimeOutU32只读变更广播手动模式下的超时时间
ManualLevelU8只读变更广播手动模式下的转速级别
LevelPercentRangeU8[]只读变更广播手动设置转速级别允许范围
ActiveAlgorithmString只读变更广播当前实时生效的算法

==方法==


SetManualLevel

设置手动模式冷却级别

参数

  • UnitId: U8 - 冷却单元Id
  • Level: U8 - 设置的转速级别

SetCtrlMode

设置冷却单元控制模式

参数

  • CtrlMode: String - 冷却单元控制模式
  • Timeout: U32 - 超时时长

bmc.kepler.Systems.MPCConfig

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播MPC是否使能,默认为false
TotalPowerSavedKwhDouble只读变更广播MPC累计节省能耗,千瓦时
LastStartTimeU32只读变更广播最近一次MPC开启时间
StatusString只读变更广播MPC模型状态,当前存在5种取值类型,Idle空闲状态,Training训练状态,Active生效状态,Inactive不生效状态,Unavailable不可用状态

bmc.kepler.Systems.Mctp

==属性==

属性名类型可读写信号通知描述
DiscoverFlagU8只读变更广播发现的标志
OwnerEidU8只读变更广播ME的Eid
OwnerPhyU16只读变更广播ME的物理地址
BmcEidU8只读变更广播BMC的Eid
BmcPhyU16只读变更广播BMC的物理地址
SystemIdU8只读变更广播系统Id
TableStatusU8只读变更广播路由表状态

bmc.kepler.Systems.Mctp.MctpBinding.PCIe

==属性==

属性名类型可读写信号通知描述
OwnerEidU8只读变更广播ME的Eid
OwnerPhyAddrU16只读变更广播ME的PCIe物理地址
BmcEidU8只读变更广播BMC的Eid
BmcPhyAddrU16只读变更广播BMC的PCIe物理地址
DiscoverFinishedBoolean只读变更广播MCTP是否完成初始化
RoutingTableReadyBoolean只读变更广播路由表是否就绪

bmc.kepler.Systems.Mctp.MctpBinding.SMBus

==属性==

属性名类型可读写信号通知描述
BmcEidU8只读变更广播SMBus协议使用的BMC的Eid
BmcPhyAddrU8只读变更广播SMBus协议使用的BMC的物理地址

bmc.kepler.Systems.Mctp.PCIeEndpoint

==属性==

属性名类型可读写信号通知描述
ServiceNameString只读变更广播注册通道的模块名
TargetEidU8只读变更广播对端的Eid
TargetPhyAddrU16只读变更广播对端PhyAddr
MessageTypeU8只读变更广播协议类型
MediumTypeU8只读变更广播物理介质类型, 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
StatusU8只读变更广播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

==属性==

属性名类型可读写信号通知描述
EidRangeSizeU8只读变更广播MCTP标准定义的路由表字段 Eid范围
StartingEidU8只读变更广播MCTP标准定义的路由表字段 起始Eid
EntryTypeU8只读变更广播MCTP标准定义的路由表字段 路由类型
PhysTransportBindingIdU8只读变更广播MCTP标准定义的路由表字段 物理通道绑定的Id
MediaTypeIdU8只读变更广播MCTP标准定义的路由表字段 物理介质类型
PhysAddressU8[]只读变更广播MCTP标准定义的路由表字段 物理地址

bmc.kepler.Systems.Mctp.PCIeTransport

==属性==

属性名类型可读写信号通知描述
ServiceNameString只读变更广播注册通道的模块名
TargetEidU8只读变更广播对端的Eid
TargetPhyAddrU16只读变更广播对端PhyAddr
MessageTypeU8只读变更广播协议类型

bmc.kepler.Systems.Memory

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
NameString只读变更广播内存名
DimmNameString只读变更广播内存槽位名
PresenceU8只读变更广播内存在位状态
CpuIdU8只读变更广播内存对应的cpuId
NodeIdU8只读变更广播内存对应的节点Id
ChannelIdU8只读变更广播内存对应的物理通道Id
LogicalChannelIdU8只读变更广播内存对应的逻辑通道Id
DimmIdU8只读变更广播内存对应的槽位Id
AllowedSpeedsMHzU32只读变更广播运行的最高操作频率
BaseModuleTypeString只读变更广播基础模块类型RDIMM、UDIMM、LRDIMM
CapacityMiBU32只读变更广播容量
DataWidthBitsU32只读变更广播数据位宽
FirmwareRevisionString只读变更广播固件修订版本
ManufacturerString只读变更广播制造商
MemoryDeviceTypeString只读变更广播内存设备类型
MemorySubsystemControllerManufacturerIDString只读变更广播子系统控制器制造商Id
MemorySubsystemControllerProductIDString只读变更广播子系统控制器产品Id
MemoryTypeString只读变更广播内存类型
OperatingSpeedMhzU32只读变更广播内存模块的时钟频率
PartNumberString只读变更广播部件号
OriginalPartNumberString只读变更广播内存的原厂部件号
RankCountU32只读变更广播Rank数
SerialNumberString只读变更广播序列号
MinVoltageMillivoltU32只读变更广播最小工作电压
PositionString只读变更广播位置
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
PredictiveFaultU8只读变更广播预故障告警状态
DeviceLocatorString只读变更广播内存的丝印
HealthU8只读变更广播健康状态
DimmNumU8只读变更广播DimmNum
BOMString只读变更广播物料清单
ManufacturerIDString只读变更广播制造商ID
ManufacturingDateString只读变更广播生产日期
ManufacturingLocationString只读变更广播制造地点
ChipBitWidthString只读变更广播内存位宽
TemperatureCelsiusDouble只读变更广播内存温度
SilkTextString只读变更广播内存的板上丝印
ErrorCorrectionString只读变更广播内存设备支持的纠错信息,取值有AddressParity、MultiBitECC、NoECC、SingleBitECC
TechnologyString只读变更广播内存的内存技术

bmc.kepler.Systems.Memory.MemoryMetrics

==属性==

属性名类型可读写信号通知描述
BandwidthPercentU8只读变更广播占用率
BandwidthThresholdPercentU8只读变更广播占用率门限
ConsumedPowerWattU32只读变更广播功耗
SystemMemoryBuffersGiBDouble只读变更广播内存的缓存区容量
SystemMemoryCachedGiBDouble只读变更广播内存的缓冲区容量
TotalSystemMemoryGiBDouble只读变更广播内存的总容量

==方法==


SetBandwidthThreshold

设置内存占用率门限

参数

  • BandwidthThresholdPercent: U8 - 内存占用率门限

返回值

  • Result: S32 - 设置内存占用率门限结果

GetBandwidthHistory

获取内存占用率的历史数据

返回值

  • History: String - 内存占用率的历史数据

ClearBandwidthHistory

清除内存占用率的历史数据


bmc.kepler.Systems.MemoryChannel

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播内存通道名
LogicalCpuIdU8只读变更广播逻辑cpuId
PhysicalChannelIdU8只读变更广播物理内存通道Id
LogicalChannelIdU8只读变更广播逻辑内存通道Id
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
SystemIdU8只读变更广播系统Id
CorrectableECCStormBurstEventU8读写变更广播内存发生超级CE风暴,取值: 0-未发生,1-发生。系统下电/复位时,恢复到未发生状态。

bmc.kepler.Systems.NCSICapabilities

==属性==

属性名类型可读写信号通知描述
PCIeNCSIEnabledU8只读变更广播PCIE标卡NCSI线缆在位标记
PCIeNCSISupportedBoolean只读变更广播用于生产查询主板对PCIE标卡NCSI功能支持能力

bmc.kepler.Systems.NPUCard

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播功耗
PowerStateU8只读变更广播NPU卡电源状态,1表示上电,0表示下电
Core0TemperatureCelsiusU16只读变更广播芯片1温度
Core1TemperatureCelsiusU16只读变更广播芯片2温度
OutletTemperatureCelsiusU16只读变更广播NPU卡出风口温度
InletTemperatureCelsiusU16只读变更广播NPU卡出风口温度
FaultStateU32只读变更广播NPU卡的故障状态
FaultCodeString只读变更广播NPU卡的故障码
McuFirmwareVersionString只读变更广播NPU卡的MCU版本
SlotNumberU32只读变更广播NPU卡的槽位
SerialNumberString只读变更广播NPU卡的序列号
BoardIDU16只读变更广播NPU卡的board id
PcbVersionString只读变更广播NPU卡的pcb版本
NameString只读变更广播NPU卡的名称
FirmwareVersionString只读变更广播系统固件版本
MemoryCapacityMiBU32只读变更广播内存容量,单位(MB)

bmc.kepler.Systems.NPUFDMService

==属性==

属性名类型可读写信号通知描述
HbmFPCEnabledBoolean读写变更广播NPU HBM FPC总开关
HbmFaultIsolationEnabledBoolean读写变更广播NPU HBM隔离修复总开关
HbmPageOfflineEnabledBoolean读写变更广播NPU HBM pageoffline开关

bmc.kepler.Systems.NetworkAdapter

==属性==

属性名类型可读写信号通知描述
IDString只读变更广播网卡ID
SystemIDU8只读变更广播系统ID
NameString只读变更广播网卡型号名称
DisplayNameString只读变更广播网卡显示名称
ManufacturerString只读变更广播厂商名称
DescriptionString只读变更广播网卡描述
PositionString只读变更广播网卡容器信息
DeviceLocatorString只读变更广播网卡丝印信息
TypeU8只读变更广播网卡类型
NetworkPortCountU8只读变更广播网口个数
ModelString只读变更广播芯片型号
ChipVendorString只读变更广播芯片厂商
ModelDescriptionString只读变更广播芯片型号描述
ChipManufacturerString只读变更广播芯片厂商
DriverNameString只读变更广播驱动名称
DriverVersionString只读变更广播驱动版本
SlotNumberU8只读变更广播槽位号
NetDevFuncCapabilitiesU8只读变更广播网卡支持的协议,0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
RootBDFString只读变更广播网卡BDF信息
FirmwareVersionString只读变更广播固件版本
VendorIDString只读变更广播厂商ID
DeviceIDString只读变更广播设备ID
SubsystemVendorIDString只读变更广播子系统厂商ID
SubsystemDeviceIDString只读变更广播子系统设备ID
BoardIDU16只读变更广播单板ID
BoardNameString只读变更广播单板名称
BoardIDHexString只读变更广播十六进制单板ID
ComponentUniqueIDString只读变更广播组件唯一标识
PCBVersionString只读变更广播PCB版本
AssociatedResourceString只读变更广播网卡资源归属
SupportedMctpBoolean只读变更广播网卡是否支持MCTP
HotPluggableBoolean只读变更广播网卡是否支持热插拔
ReadyToRemoveBoolean只读变更广播热拔出是否已准备好
AttentionHotPlugStateU8只读变更广播热插拔状态:0 - 不可操作;1 - 可拔出;2 - 可插入;其他 - 未知
SerialNumberString只读变更广播序列号
PreviousSerialNumberString只读变更广播更换前的序列号
TemperatureCelsiusS16只读变更广播芯片温度
TemperatureStatusU8只读变更广播芯片温度状态:0 - 正常;1 - 失效
MaxOperatingTemperatureCelsiusU16只读变更广播网卡在稳态下支持的最大温度
LLDPSupportedBoolean只读变更广播网卡是否支持LLDP
FruIdU8只读变更广播网卡电子标签
PredictiveFaultU8读写变更广播预测故障标志位
DiagnosticFaultU8读写变更广播故障诊断定位标志位
ReplacedFlagU8只读变更广播网卡更换标志位
SupportedLLDPBoolean只读变更广播网卡是否支持LLDP
ParentCardSlotIdU8只读变更广播关联上一级卡的槽位号
PfMacInfoArray只读变更广播Physical Function Mac信息
BandwidthThresholdPercentU16只读变更广播网络带宽占用率门限
NodeIdString只读变更广播网卡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

==属性==

属性名类型可读写信号通知描述
LinkWidthCapabilityString只读变更广播网卡支持的最大带宽能力
LinkSpeedCapabilityString只读变更广播网卡支持的最大速率能力
LinkWidthString只读变更广播网卡实际带宽
LinkSpeedString只读变更广播网卡实际速率
SFPMaxTemperatureCelsiusS16只读变更广播光模块最大温度,用于调速,单位:摄氏度

bmc.kepler.Systems.NetworkAdapter.Status

==属性==

属性名类型可读写信号通知描述
HealthU8只读变更广播网卡健康状态, 0:OK, 1:Minor, 2:Major, 3:Critical
FaultCodeString只读变更广播异常码
FaultStateU32只读变更广播故障状态,用于告警配置

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

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播Bonding ID, 由BMA获取bonding资源时生成
NameString只读变更广播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

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播网桥ID
NameString只读变更广播网桥名称

bmc.kepler.Systems.NetworkPort

==属性==

属性名类型可读写信号通知描述
SystemIDU8只读变更广播系统ID
NodeIdString只读变更广播网口NodeId
NameString只读变更广播网口名称
TypeU8只读变更广播网口类型
PortIDU8只读变更广播网口ID
PermanentMACAddressString只读变更广播永久MAC地址
MACAddressString只读变更广播MAC地址
LinkStatusString读写变更广播链路状态
LinkStatusNumericU8读写变更广播链路状态
IPv6DefaultGatewayString只读变更广播IPv6默认网关
WorkModeString只读变更广播工作模式
FunctionTypeString只读变更广播网口类型:物理,虚拟
BDFString只读变更广播网口BDF
AutoConnectOnBootBoolean只读变更广播开机是否自动启用网络连接
NetDevFuncTypeU8只读变更广播网络设备功能类型,0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
MediumTypeString只读变更广播网口介质类型
SpeedMbpsU32只读变更广播链路速率
FullDuplexBoolean只读变更广播是否开启全双工
AutoSpeedNegotiationBoolean只读变更广播是否处于自协商模式
FirmwareVersionString只读变更广播固件版本
DriverNameString只读变更广播驱动名称
DriverVersionString只读变更广播驱动版本
LLDPEnabledBoolean读写变更广播网口LLDP使能 false:关闭使能 true:打开使能
SupportedLinkCapabilityString只读变更广播支持的传输速率
NetworkAdapterIdString只读变更广播对应的网卡ID属性
LinkMonitorPeriodMSU32只读变更广播网口链路监测周期,单位毫秒
UUIDString只读变更广播网口全球唯一标识,用于IB卡。只读属性,默认为空。
WorkloadTypeU8只读变更广播工作负载类型,0:负载服务器os;1:负载智能网卡的os;2:服务器os及智能网卡os均卸载

==方法==


Configure

配置网口

参数

  • Request: Object - 配置网口时传入的参数列表,如连接状态、地址、掩码等

返回值

  • TaskId: U32 - 任务ID

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.NetworkPort.DataCenterBridging

==属性==

属性名类型可读写信号通知描述
Up2cosU8[]只读变更广播DCB 信息中的 Up2cos
UppgidU8[]只读变更广播DCB 信息中的 Uppgid
PgpctU8[]只读变更广播DCB 信息中的 Pgpct
PgStrictU8[]只读变更广播DCB 信息中的 PgStrict
PfcmapU8只读变更广播DCB 信息中的 Pfcmap

bmc.kepler.Systems.NetworkPort.FibreChannel

==属性==

属性名类型可读写信号通知描述
FCIdString只读变更广播FC ID信息
WWNNString只读变更广播当前生效WWNN号
PermanentWWNNString只读变更广播出厂WWNN号
WWPNString只读变更广播当前生效WWPN号
PermanentWWPNString只读变更广播出厂WWPN号
SpeedGbpsU32只读变更广播端口链接速率,单位Gb,用于FC卡

bmc.kepler.Systems.NetworkPort.LLDPReceive

==属性==

属性名类型可读写信号通知描述
ChassisIdString只读变更广播从网络交换机接收到的Chassis ID
ChassisIdSubtypeString只读变更广播从网络交换机接收到的Chassis ID类型
PortIdString只读变更广播从网络交换机接收到的端口ID
PortIdSubtypeString只读变更广播从网络交换机接收到的端口ID类型
SystemNameString只读变更广播网络交换机名称
ManagementVlanIdU16只读变更广播从网络交换机接收到的VLAN ID

bmc.kepler.Systems.NetworkPort.Metrics

==属性==

属性名类型可读写信号通知描述
RXFramesString只读变更广播收到的帧数量
TXFramesString只读变更广播发送的帧数量
PacketsDroppedU64只读变更广播丢包总数
RXUnicastFramesString只读变更广播收到的单播帧数量
RXMulticastFramesString只读变更广播收到的多播帧数量
RXBroadcastFramesString只读变更广播收到的广播帧数量
TXUnicastFramesString只读变更广播发送的单播帧数量
TXMulticastFramesString只读变更广播发送的多播帧数量
TXBroadcastFramesString只读变更广播发送的广播帧数量
RXFCSErrorsString只读变更广播接收到的校验错误帧数量
RXUndersizeFramesString只读变更广播接收到的超小帧数量
RXOversizeFramesString只读变更广播接收到的超长帧数量
TXSingleCollisionsString只读变更广播发送的单碰撞帧数量
TXMultipleCollisionsString只读变更广播发送的多碰撞帧数量
TXLateCollisionsString只读变更广播发送的延迟碰撞帧数量
TXExcessiveCollisionsString只读变更广播发送的超量碰撞帧数量
RXFrameAlignmentErrorsString只读变更广播接收的对齐错误的帧数量
BandwidthUsagePercentDouble只读变更广播网络带宽占用率

bmc.kepler.Systems.NetworkPort.VLAN

==属性==

属性名类型可读写信号通知描述
VLANIdU16只读变更广播VLAN ID
VLANEnabledBoolean只读变更广播VLAN是否启用
VLANPriorityU8只读变更广播VLAN优先级
AutoConnectOnBootBoolean只读变更广播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

==属性==

属性名类型可读写信号通知描述
CpuFrequencyMHzArray只读变更广播设置CPU Numa/Core频率(MHZ)
MsgMaxU32只读变更广播消息队列中单个消息的最大字节数
CFSBandwidthSliceUSU32只读变更广播CFS带宽控制
NrMigrateU32只读变更广播负载平衡可跨处理器迁移的任务数
MigrationCostNSU32只读变更广播任务迁移阈值
MinGranularityNSU32只读变更广播CPU上进程的最短运行时间
SwappinessU8只读变更广播swap的物理内存剩余空间百分比阈值
DirtyRatioU8只读变更广播脏数据提交阈值

==方法==


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

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播名称
ManufacturerString只读变更广播厂商名称
PartNumberString只读变更广播厂商部件名称
SerialNumberString只读变更广播序列号
RevisionNumberString只读变更广播产品修订版本号, ASCII字符串, 长度为2字符
ProductionDateString只读变更广播生产日期
TransceiverTypeString只读变更广播收发器类型
FiberConnectionTypeString只读变更广播传输模式
WaveLengthNanometerString只读变更广播波长,单位纳米
TypeString只读变更广播类型
SupportedSpeedsMbpsDouble[]只读变更广播支持的速率
HealthU8只读变更广播健康状态
IdentifierString只读变更广播识别码
ConnectorTypeString只读变更广播连接器类型
MediumTypeString只读变更广播介质类型
TransmissionDistanceString只读变更广播传输距离
RxLossStateBoolean只读变更广播发送端信号是否丢失
TxLossStateBoolean只读变更广播接收端信号是否丢失
TxFaultStateBoolean只读变更广播接收端是否故障
TypeMatchBoolean只读变更广播类型是否匹配
SpeedMatchBoolean只读变更广播速率是否匹配
FaultStateU32只读变更广播故障状态
TemperatureCelsiusDouble只读变更广播光模块温度(用于告警)
PowerStateU8只读变更广播功率异常标志位(用于告警)
IsSupportedTypeU8只读变更广播网卡支持速率与光模块速率不匹配标志位(用于告警)
PresenceU8只读变更广播光模块是否在位
ChannelNumU8只读变更广播光模块内部通道数
RxSNRDouble[]只读变更广播端口接收信噪比
HostSNRDouble[]只读变更广播主机侧信噪比
MediaSNRDouble[]只读变更广播介质侧信噪比
AccessibleU8只读变更广播光模块是否可访问,0为不可访问,1为可访问
ModuleStateU8只读变更广播光模块当前运行状态, 默认值为255, 1: ModuleLowPwr, 2: ModulePwrUp, 3: ModuleReady, 4: ModulePwrDn, 5: ModuleFault, 其余取值为光模块厂家自定义状态

bmc.kepler.Systems.OpticalModule.BiasCurrent

==属性==

属性名类型可读写信号通知描述
TXBiasCurrentMilliAmpsDouble[]只读变更广播读取的电流,单位毫安
TXBiasCurrent1MilliAmpsDouble只读变更广播读取的通道1的电流,单位毫安
TXBiasCurrent2MilliAmpsDouble只读变更广播读取的通道2的电流,单位毫安
TXBiasCurrent3MilliAmpsDouble只读变更广播读取的通道3的电流,单位毫安
TXBiasCurrent4MilliAmpsDouble只读变更广播读取的通道4的电流,单位毫安
TXBiasCurrent5MilliAmpsDouble只读变更广播读取的通道5的电流,单位毫安
TXBiasCurrent6MilliAmpsDouble只读变更广播读取的通道6的电流,单位毫安
TXBiasCurrent7MilliAmpsDouble只读变更广播读取的通道7的电流,单位毫安
TXBiasCurrent8MilliAmpsDouble只读变更广播读取的通道8的电流,单位毫安
TXBiasCurrentStatusU32只读变更广播偏置电流异常状态;每个bit对应一个通道,某个bit取值1表示是对应偏置电流通道故障;当前光模块最多8通道,属性预留32位便于扩展
TXLowerThresholdCriticalDouble只读变更广播发送偏置电流告警下限阈值
TXUpperThresholdCriticalDouble只读变更广播发送偏置电流告警上限阈值
BiasCurrentTXUpperThresholdWarningDouble只读变更广播发送偏置电流警告上限阈值
BiasCurrentTXLowerThresholdWarningDouble只读变更广播发送偏置电流警告下限阈值

bmc.kepler.Systems.OpticalModule.Channel

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播光模块RX/TX通道号
BiasCurrentMilliAmpsDouble只读变更广播通道的偏置电流,单位毫安
RXPowerMilliWattsDouble只读变更广播通道的接收功率,单位毫瓦
TXPowerMilliWattsDouble只读变更广播通道的发送功率,单位毫瓦

bmc.kepler.Systems.OpticalModule.Diagnose

==属性==

属性名类型可读写信号通知描述
RxLossOfLockU8只读变更广播接受方向的CDR失败状态
TxLossOfLockU8只读变更广播发送方向的CDR失败状态
LaserRuntimeSecondsU32只读变更广播激光器运行时间,单位:秒
LaserTemperatureCelsiusDouble只读变更广播激光器管芯温度
PowerOnCountU16只读变更广播模块上电次数
UptimeSecondsU32只读变更广播模块上电时间,单位:秒
PowerStatusU16只读变更广播模块上电状态
OdspDieTemperatureCelsiusDouble只读变更广播ODSP结温
OdspHighTempRuntimeSecondsU32只读变更广播ODSP高温运行时间,单位:秒
SelfTestStatusU64只读变更广播光模块自体诊断告警状态,轻微隐患和严重故障各32bit
MediaInterfaceFaultStatusU16只读变更广播光链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
HostInterfaceFaultStatusU16只读变更广播电链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
RxLoSU32只读变更广播接收端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
TxLoSU32只读变更广播发送端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
TxFaultU32只读变更广播发送错误;每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
PRBSTestSupportedBoolean只读变更广播此光模块是否支持PRBS压测
FiberDirtyDetectedBoolean读写变更广播光模块是否脏污
FiberLoosenessDetectedBoolean读写变更广播光模块是否松动

bmc.kepler.Systems.OpticalModule.Power

==属性==

属性名类型可读写信号通知描述
RXInputPowerMilliWattsDouble[]只读变更广播读取的接收功率,单位毫瓦
RXInputPowerStatusU32只读变更广播接收功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应接收功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
RXLowerThresholdCriticalDouble只读变更广播接收功率告警下限阈值
RXUpperThresholdCriticalDouble只读变更广播接收功率告警上限阈值
TXOutputPowerMilliWattsDouble[]只读变更广播读取的发送功率,单位毫瓦
TXOutputPowerStatusU32只读变更广播发送功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应发送功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
TXLowerThresholdCriticalDouble只读变更广播发送功率告警下限阈值
TXUpperThresholdCriticalDouble只读变更广播发送功率告警上限阈值
PowerTXUpperThresholdWarningDouble只读变更广播发送功率警告上限阈值
PowerTXLowerThresholdWarningDouble只读变更广播发送功率警告下限阈值
PowerRXUpperThresholdWarningDouble只读变更广播接收功率警告上限阈值
PowerRXLowerThresholdWarningDouble只读变更广播接收功率警告下限阈值
PowerClassU8只读变更广播光模块功耗分类, 默认值为255, 分类对应功耗由光模块协议定义
PowerCapacityWattsDouble只读变更广播光模块允许的最大额定功耗

bmc.kepler.Systems.OpticalModule.Temperature

==属性==

属性名类型可读写信号通知描述
ReadingCelsiusDouble只读变更广播读取的芯片温度
LowerThresholdCriticalDouble只读变更广播下限阈值
UpperThresholdCriticalDouble只读变更广播上限阈值
TemperatureLowerThresholdCriticalDouble只读变更广播低温告警阈值
TemperatureUpperThresholdCriticalDouble只读变更广播高温告警阈值
TemperatureLowerThresholdWarningDouble只读变更广播低温警告阈值
TemperatureUpperThresholdWarningDouble只读变更广播高温警告阈值

bmc.kepler.Systems.OpticalModule.Voltage

==属性==

属性名类型可读写信号通知描述
SupplyVoltageDouble只读变更广播供电电压
LowerThresholdCriticalDouble只读变更广播下限阈值
UpperThresholdCriticalDouble只读变更广播上限阈值
VoltageLowerThresholdCriticalDouble只读变更广播低压告警阈值
VoltageUpperThresholdCriticalDouble只读变更广播高压告警阈值
VoltageLowerThresholdWarningDouble只读变更广播低压警告阈值
VoltageUpperThresholdWarningDouble只读变更广播高压警告阈值

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

==属性==

属性名类型可读写信号通知描述
PortIdU8只读变更广播网口的物理编号,每张网卡从0开始
LaneIdU8只读变更广播网口的逻辑lane编号,每张网卡从0开始
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
SocketIDU8只读变更广播网卡对应的CPU ID
ControllerIndexU8只读变更广播网卡对应的Eth控制器ID
BusU8只读变更广播网口设备的Bus
DeviceU8只读变更广播网口设备的Device
FunctionU8只读变更广播网口设备的Function
PortFunctionIdU8只读变更广播网口设备的PortFunctionId

bmc.kepler.Systems.PCIeDevices.PCIeCard

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播产品名称(SP580等)
SlotIDU8只读变更广播槽位号
DeviceNameString只读变更广播设备资源名称
FunctionClassU8只读变更广播功能分类(0:未知、1:RAID、2:网卡、3:GPU卡、4:存储卡(SSD卡/M.2卡)、5:SDI卡、6:加速卡、7:扩展卡(PCIe Riser)、8:FPGA卡、9:NPU卡)
DescriptionString只读变更广播描述
PcbVersionString只读变更广播PCB版本
BoardIDU16只读变更广播单板ID(仅自研卡涉及)
BoardNameString只读变更广播单板名称(仅自研卡涉及)
LinkWidthAbilityString只读变更广播最大链路带宽
LinkWidthString只读变更广播链路带宽
LinkSpeedCapabilityString只读变更广播最大链路速率
LinkSpeedString只读变更广播链路速率
VendorIDU16只读变更广播制造商ID
DeviceIDU16只读变更广播设备ID
SubVendorIDU16只读变更广播子厂商ID
SubDeviceIDU16只读变更广播子设备ID
PositionString只读变更广播位置信息(容器信息)
ManufacturerString只读变更广播厂商
LaneOwnerU8只读变更广播资源归属,起始值为1,表示当前卡挂在哪个CPU下
FirmwareVersionString只读变更广播固件版本
PartNumberString只读变更广播部件编码
SerialNumberString只读变更广播序列号
RefComponentString只读变更广播关联部件对象
HealthU8只读变更广播健康状态
ModelString只读变更广播PCIe卡的型号
NodeIDString只读变更广播通过PCIe卡所在容器和槽位得到的唯一标识符
PresenceU8只读变更广播在位状态
CardModelString只读变更广播PCIe设备型号
CardManufacturerString只读变更广播PCIe设备制造商
CardForServersU8[]只读变更广播PCIe设备服务的系统Id列表

bmc.kepler.Systems.PCIeDevices.PCIeDevice

==属性==

属性名类型可读写信号通知描述
SlotIDU8只读变更广播槽位号
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
SocketIDU8只读变更广播CPU ID
BusU8只读变更广播root port Bus
DeviceU8只读变更广播root port Device
FunctionU8只读变更广播root port Function
DevBusU8只读变更广播设备总线
DevDeviceU8只读变更广播设备的 Device
DevFunctionU8只读变更广播设备的 Function
DiagnosticFaultU8只读变更广播严重故障诊断告警状态
PredictiveFaultU8只读变更广播预故障告警状态
UCEByBIOSU8只读变更广播BIOS上报不可纠正错误标识,相当于V2 fatalerror
BandwidthReductionU8只读变更广播PCIE降带宽检测失败上报事件属性
LinkSpeedReducedU8只读变更广播PCIe设备降速率检测告警上报事件属性(BIOS上报)
FunctionClassU8只读变更广播PCIEe设备的功能分类
DeviceNameString只读变更广播设备资源名称
PositionString只读变更广播设备位置(容器名称)
FaultByBiosU8只读变更广播Bios上报的异常状态
SlotTypeString只读变更广播PCIe槽位类型
FunctionProtocolString只读变更广播PCIe功能协议
FunctionTypeString只读变更广播PCIe功能类型
PCIeTypeString只读变更广播PCIe设备所在槽位使用的规范版本
MaxPCIeTypeString只读变更广播PCIe设备本身能支持的最高协议版本
NegotiatedPCIeTypeString只读变更广播PCIe设备实际协商的协议版本
PCIeDeviceTypeString只读变更广播PCIe设备类型
BaseClassCodeU8只读变更广播PCIe设备功能的基类码
SubClassCodeU8只读变更广播PCIe设备功能的子类码
ProgrammingInterfaceU8只读变更广播PCIe设备功能的编程接口

bmc.kepler.Systems.PCIeDevices.PCIeDevice.RAS

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误, 取值: 0-未发生, 1-发生
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误, 取值: 0-未发生,1-发生
FatalErrorU8只读变更广播PCIe设备发生致命错误, 取值: 0-未发生,1-发生
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误, 取值: 0-未发生,1-发生
SystemErrorU8只读变更广播PCIe设备发生系统错误, 取值: 0-未发生,1-发生
FatalErrorCountU32读写变更广播PCIe设备致命错误计数
NonFatalErrorCountU32读写变更广播PCIe设备非致命错误计数

bmc.kepler.Systems.PcieAddrInfo

==属性==

属性名类型可读写信号通知描述
GroupIDU8只读变更广播逻辑组ID
SlotIDU8只读变更广播槽位id
PortIDU8只读变更广播pcie槽位对应的portId,用于上报bios槽位与portid对应的关系,计算对应槽位的rootBDF
ComponentTypeU8只读变更广播部件类型,与Component类的中的部件类型属性对应。(标准定义,如:8:PCIe标卡、13:NCI卡、83:OCP卡)
ControllerIndexU8只读变更广播PCIe控制器索引,CPU内部同类型控制器的索引,从0开始编号
ControllerTypeU8只读变更广播PCIe控制器类型(0:PCIeCore,1:NIC,2:SAS,3:SATA,4:ZIP,5:SEC)
SocketIDU8只读变更广播CPU ID
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
BusU8只读变更广播root port Bus号
DeviceU8只读变更广播root port Device号
FunctionU8只读变更广播root port Function号
VendorIDU16只读变更广播供应商id
DeviceIDU16只读变更广播设备id

bmc.kepler.Systems.Pmu

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
StatusU8只读变更广播状态
PmuTypeU8只读变更广播Pmu类型
PmuVersionString只读变更广播Pmu版本
SFPMaxTemperatureU16只读变更广播光模块最大温度

==方法==


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

==属性==

属性名类型可读写信号通知描述
PowerOnTimeoutFlagU8读写变更广播上电超时状态

bmc.kepler.Systems.PowerMgmt

==属性==

属性名类型可读写信号通知描述
IsManufacturerMismatchBoolean只读变更广播服务器多个输入电源模块的厂商是否一致匹配
IsModelMismatchBoolean只读变更广播服务器多个输入电源模块的型号是否一致匹配

bmc.kepler.Systems.PowerMgmt.OnePower

==属性==

属性名类型可读写信号通知描述
SlotNumberU32只读变更广播槽位号
ManufacturerString只读变更广播厂商
ModelString只读变更广播电源型号
PowerSupplyTypeU32只读变更广播电源模块的供电类型,0:DC; 1:AC; 2: ACorDC; 3: Unknown
PresenceU8只读变更广播在位状态
PowerSupplyChannelU8只读变更广播电源供电电路,0:主路 1:备路
SerialNumberString只读变更广播序列号
PartNumberString只读变更广播部件编码
FirmwareVersionString只读变更广播电源固件版本
ProtocolString只读变更广播
DeviceLocatorString只读变更广播物理位置
ProductionDateString只读变更广播生产日期
WorkModeString只读变更广播单个电源主备工作模式(主用:Enabled,备用:StandbySpare)
PositionString只读变更广播容器信息
TotalRunningHoursU32只读变更广播总运行时间
RedundancyGroupIdU8只读变更广播电源冗余组ID,非0值代表此电源冗余,0值代表电源不是冗余电源组的一员
InputVoltageTypeU8只读变更广播交直流模式 0:DC; 1:AC
DMTFPowerSupplyTypeU8只读变更广播DMTF电源类型: 1 Other;2 Unknown;3 Linear; 4 Switching; 5 Battery; 6 UPS; 7 Converter; 8 Regulator
SourceTypeU8只读变更广播功率读数来源,0:chip(功率传感器芯片,如INA220); 1:PSU(电源MCU)
IsPartOfSysPowerBoolean只读变更广播是否参与整机功耗计算,true:功耗纳入整机功耗计算,false:功耗不纳入整机功耗计算
LineInputVoltageTypeString只读变更广播电源模块支持的供电类型

==方法==


SetPowerWorkMode

设置电源工作模式

参数

  • PowerWorkMode: U8 - 电源工作模式,1:设置为备用,0:设置为主用

返回值

  • CmdResult: U8 - 命令执行结果,0:设置成功,1:设置失败

bmc.kepler.Systems.PowerMgmt.OnePower.EfficiencyCurve

==属性==

属性名类型可读写信号通知描述
EfficiencyCurveArray只读变更广播电源转换效率曲线,键值表示电源负载百分比,值表示对应负载下的转换效率
PowerLevelString只读变更广播电源模块等级, 80PLUS:白牌;80PLUS Bronze:铜牌;80PLUS Silver:银牌;80PLUS Gold:金牌;80PLUS Platinum:白金牌;80PLUS Titanium:钛金牌;N/A:未知

==自定义类型==


EfficiencyCurveObject: 结构体类型

  • LoadPercent: U8 - 电源负载百分比
  • EfficiencyValue: Double - 电源转换效率

bmc.kepler.Systems.PowerMgmt.OnePower.Metrics

==属性==

属性名类型可读写信号通知描述
RateU16只读变更广播额定功率
InputVoltageDouble只读变更广播输入电压
OutputVoltageDouble只读变更广播输出电压
InputCurrentAmpsDouble只读变更广播输入电流
OutputCurrentAmpsDouble只读变更广播输出电流
InputPowerWattsDouble只读变更广播单电源输入功率
OutputPowerWattsDouble只读变更广播单电源输出功率
RatedCurrentAmpsU16只读变更广播额定电流
InputFrequencyHzDouble只读变更广播电源频率,交流显示频率 直流显示为0

bmc.kepler.Systems.PowerMgmt.OnePower.Status

==属性==

属性名类型可读写信号通知描述
HealthU8只读变更广播电源模块状态
IsUpgradingBoolean只读变更广播电源升级标识(false:未升级,true:升级中)
OutputStateU8只读变更广播电源电压输出状态(0为异常)
NormalAndRedundancySupportedBoolean只读变更广播是否支持N+R(true:支持,false:不支持)
SleepModeString只读变更广播电源休眠模式(Normal,DeepSleep)
InputVoltageFaultU16只读变更广播电压输入状态(bit7:Vin_Ov_Fault, bit6:Vin_Ov_Warning, bit5:Vin_Uv_Warning, bit4:Vin_Uv_Fault),无效值32768,EVENT不处理
OutputVoltageFaultU8只读变更广播电压输出状态(bit7:Vout_Ov_Fault, bit6:Vout_Ov_Warning, bit5:Vout_Uv_Warning, bit4:Vout_Uv_Fault)
OutputCurrentFaultU8只读变更广播电流输出状态(bit7:Iout_Oc_Fault, bit5:Iout_Oc_Warning)
FanFaultU8只读变更广播风扇状态(bit7:Fan1_Fault, bit5:Fan1_Warning, bit3:Fan1_Speed_Override)
Fan1FaultU8只读变更广播风扇1故障 0:无故障; 1:有故障(pmbus 只有一个风扇状态,pmbus8100 区分Fan1/2)
Fan2FaultU8只读变更广播风扇2故障 0:无故障; 1:有故障
OverTemperatureU8只读变更广播过温故障 0:无故障; 1:有故障
FailureU8只读变更广播电源故障 0:无故障; 1:有故障
LossOfInputU8只读变更广播输入故障 0:无故障; 1:有故障
DeepSleepEnabledU8只读变更广播电源深度休眠使能(供告警使用) 0:未使能, 1:使能
ScanStatusU8只读变更广播电源信息采集任务执行情况(bit0:电源功率轮询,bit1:电源输入/输出 电流/电压查询,bit2:电源模式查询)0表示该属性未获取过,1表示获取过
InputVoltageStatusU8只读变更广播输入电压过欠压、掉电状态,0x00:表示正常(默认);0x01:表示过压;0x02:表示欠压;0x03:表示掉电;
CommunicationStatusU8只读变更广播电源通信状态,0:正常,1:故障
EquipmentModeU8只读变更广播电源装备模式, 0: 装备模式, 1: 非装备模式, 255: 未知(默认)

==方法==


SetSleepMode

设置电源休眠模式

参数

  • SleepMode: String - 电源休眠模式:Normal或DeepSleep

返回值

  • CmdResult: U8 - 命令执行结果,0:设置成功,1:设置失败

bmc.kepler.Systems.PowerMgmt.OnePower.Temperatures

==属性==

属性名类型可读写信号通知描述
InletTemperatureCelsiusDouble只读变更广播进风口温度
InnerTemperatureCelsiusDouble只读变更广播出风口温度
EnvTemperatureCelsiusDouble只读变更广播单个电源的环境温度
PrimaryChipTemperatureCelsiusDouble只读变更广播电源内部器件温度(原边)
SecondaryChipTemperatureCelsiusDouble只读变更广播电源内部器件温度(副边)

bmc.kepler.Systems.PowerOnLock

==属性==

属性名类型可读写信号通知描述
PwrOnLockedBoolean只读变更广播是否满足上电条件
ReasonsString[]只读变更广播不允许上电的原因,KVM呈现,记录所有原因

==方法==


SetPowerOnLock

系统上电锁

参数

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

返回值

  • CmdResult: U8 - 函数执行结果

bmc.kepler.Systems.PowerStrategy

==属性==

属性名类型可读写信号通知描述
PowerWorkingModeString只读变更广播电源工作模式
PowerActualWorkingModeString只读变更广播电源实际工作模式
PowerLimitValueU32只读变更广播功耗封顶值
PowerLimitEnabledBoolean只读变更广播功耗封顶使能
ExpectedActivePSUU8[]只读变更广播期望的主用电源列表
MaxPowerLimitInWattsU32只读变更广播功耗封顶上限值
MinPowerLimitInWattsU32只读变更广播功耗封顶下限值
WorkModeConfigurableBoolean只读变更广播是否支持电源工作模式
PowerLimitFailedBoolean只读变更广播功耗封顶是否失败
PowerLimitActivatedBoolean只读变更广播功耗封顶策略是否触发
PowerLimitExceptionSupportedBoolean只读变更广播是否支持功耗封顶失败动作
PowerLimitExceptionLogEventBoolean读写变更广播是否支持功耗封顶失败动作记录事件日志
PowerLimitExceptionString读写变更广播功耗封顶失败动作,包括不操作、重启且记录事件日志、下电且记录事件日志
DeepSleepString读写变更广播深度休眠使能
PowerLimitWhenSteadyBoolean读写变更广播功耗封顶是否受限于BMC初始化完成
NormalAndRedundancyString只读变更广播N+R使能
DeepSleepSupportedBoolean只读变更广播是否支持电源深度休眠功能
NormalAndRedundancySupportedBoolean只读变更广播是否支持N+R备电功能
ActiveStandbySupportedBoolean只读变更广播是否支持电源主备模式功能
PowerCappingSupportedBoolean只读变更广播是否支持功耗封顶功能
PowerPredictSupportedBoolean只读变更广播是否支持节能收益预测功能
EnergyEfficiencyOptimizationSupportedBoolean只读变更广播是否支持智能能效寻优
EnergySavingSupportedBoolean只读变更广播是否支持节能功能
PSUsOutputVoltageLowBoolean只读变更广播N+R压差是否异常
RedundancyFailureBoolean只读变更广播冗余失效
PresetLimitInWattsU32读写变更广播预设功率封顶值
HighPowerThresholdWattsDouble只读变更广播功耗告警阈值
PowerLimitModeString只读变更广播功耗封顶模式
PSUsUnavailableOfflineCauseU32只读变更广播电源不可用原因,bit0:电源输入丢失,京东定制电源线未插报电源冗余告警时使用
PSUsOutputCurrentImbalanceBoolean只读变更广播电源均流不平衡
RedundancyModeU16只读变更广播系统电源冗余模式, 高字节代表主用电源数, 低字节代表冗余电源数量, 例:0x0301表示3+1冗余

==方法==


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

==属性==

属性名类型可读写信号通知描述
ProcessorTypeString只读变更广播处理器类型
SystemIdU8只读变更广播系统Id
IdU8只读变更广播Id
NameString只读变更广播名字
PresenceU8只读变更广播在位信息
InstructionSetString只读变更广播指令集
ArchitectureString只读变更广播芯片架构
ManufacturerString只读变更广播厂商
FamilyString只读变更广播处理器家族
ModelString只读变更广播产品型号
PartNumberString只读变更广播部件号
SNString只读变更广播序列号
FirmwareVersionString只读变更广播固件版本
SocketDesignationString只读变更广播槽位
PositionString只读变更广播容器:buc、pcie卡等
ThermalTripU8读写变更广播CPU的过热保护状态
HealthU8只读变更广播健康状态
ReplaceableBoolean只读变更广播此部件是否可以作为独立的部件进行替换

bmc.kepler.Systems.Processor.CPU

==属性==

属性名类型可读写信号通知描述
PhysicalIdU8只读变更广播物理ID
LogicalIdU8只读变更广播逻辑ID
MaxSpeedMHzU32只读变更广播最大转速
CurrentSpeedMHzU32只读变更广播当前转速
ProcessorIDU32只读变更广播处理器标识数据,按照SMBIOS规范定义,处理器标识数据长度为8字节,此属性位宽不足,因此已被弃用,改用此接口下的ProcessorIDString属性
ProcessorIDStringString只读变更广播处理器标识数据,字符串格式为XX-XX-XX-XX-XX-XX-XX-XX,X表示16进制数字
TotalCoresU32只读变更广播总核数
TotalEnabledCoresU32只读变更广播可用核数
TotalThreadsU32只读变更广播总线程
L1CacheU32只读变更广播一级缓存
L2CacheU32只读变更广播二级缓存
L3CacheU32只读变更广播三级缓存
CharacteristicsString只读变更广播特性
TemperatureCelsiusDouble读写变更广播温度(摄氏度)
MaxMemoryTemperatureCelsiusDouble读写变更广播最大温度
MaxMemoryTSensorTemperatureCelsiusS16读写变更广播最大TSensor温度(摄氏度)
MaxMemoryTemperatureNameString读写变更广播CPU下挂的最高温度内存标识
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
PredictiveFaultU8读写变更广播预故障告警状态
CATERRU8只读变更广播宕机信号
DeviceLocatorString只读变更广播处理器资源的丝印,以系统维度中的CPU个数。
ProcessorHotU8只读变更广播CPU的内核过热保护状态,确认是否通用
EnabledBoolean只读变更广播启用状态
PowerGoodU8只读变更广播电源状态
IsMemoryPresenceU8只读变更广播CPU下是否存在在位的内存,存在为1,否则为0
PowerWattDouble只读变更广播CPU功率
TotalEnabledThreadsU32只读变更广播使能的超线程数
SilkTextString只读变更广播处理器资源的板上丝印
BaseSpeedMHzU32只读变更广播处理器的基本(标称)时钟速度,以MHz为单位

bmc.kepler.Systems.Processor.GPU

==属性==

属性名类型可读写信号通知描述
InfoRomVersionString只读变更广播InfoRom版本
SlotString只读变更广播槽位号
VendorIDU16只读变更广播厂商Id
DeviceIDU16只读变更广播设备ID
SubVendorIDU16只读变更广播子系统厂商Id
SubDeviceIDU16只读变更广播子系统设备Id
GPUUtilizationU16只读变更广播GPU 利用率(%)
MemoryUtilizationU16只读变更广播GPU 内存利用率(%)
BoardPartNumberString只读变更广播单板部件号
MemoryVendorString只读变更广播内存厂商
MemoryPartNumberString只读变更广播内存部件号
BuildDateString只读变更广播构建时间
UUIDString只读变更广播通用唯一标识符
PrimaryGPUTemperatureCelsiusDouble只读变更广播主处理器温度

bmc.kepler.Systems.Processor.GPU.Power

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播功率
PowerBrakeSetU8只读变更广播power brake状态
ExternalPowerSufficientU8只读变更广播外部供电是否充足

bmc.kepler.Systems.Processor.GPU.Status

==属性==

属性名类型可读写信号通知描述
ECCModeEnabledU8只读变更广播ECC模式当前使能状态
ECCModePendingEnabledU8只读变更广播ECC模式重启后使能状态
ResetRequiredU8只读变更广播是否需要重启
DoubleBitErrorPageCountU32只读变更广播双bit失效故障页个数
SingleBitErrorPageCountU32只读变更广播单bit失效故障页个数
NvLinkInfoArray只读变更广播连接状态、Replay错误计数、Recovery错误计数、流控CRC错误计数、数据CRC错误计数

==自定义类型==


NvLinkInfoItem: 结构体类型

  • LinkStatus: String - 连接状态
  • ReplayErrorCount: U32 - Replay错误计数
  • RecoveryErrorCount: U32 - Recovery错误计数
  • FlowControlCRCErrorCount: U32 - 流控CRC错误计数
  • DataCRCErrorCount: U32 - 数据CRC错误计数

bmc.kepler.Systems.Processor.NPU

==属性==

属性名类型可读写信号通知描述
TotalMemoryKiBU32只读变更广播片上内存-总内存大小
MemoryUsageKiBU32只读变更广播片上内存-内存已用大小
MemoryFreeKiBU32只读变更广播片上内存-内存剩余大小
CapabilitySupportMaskU32只读变更广播能力支持掩码
MemoryCapacityKiBU32只读变更广播板卡NPU芯片-内存容量
MultiBitEccString只读变更广播多bit ECC信息
SingleBitEccString只读变更广播单bit ECC信息
AiCPUUsagePercentU16只读变更广播AiCpu使用率(%)
HBMBWUsagePercentU16只读变更广播HBM带宽使用率(%)
MemBWUsagePercentU16只读变更广播内存带宽使用率(%)
HBMUsagePercentU16只读变更广播HBM容量使用率(%)
MemUsagePercentU16只读变更广播内存容量使用率(%)
AiCoreUsagePercentU16只读变更广播核心网使用百分比
AiCoreMaxSpeedMHzU16只读变更广播Ai Core占用率(%)
AiCoreCurrentSpeedMHzU16只读变更广播Ai Core当前主频,单位:MHz
CtrlCPUUsagePercentU16只读变更广播ctrl CPU 占用率
ComputeCapabilityString只读变更广播芯片算力规格
NimBusTempU16只读变更广播芯片外围设备NimBus温度
AiCoreTempU16只读变更广播AiCore计算核心温度
HBMTempU16只读变更广播HBM内存温度
PowerOnU8只读变更广播开机
PowerStateString只读变更广播NPU芯片上下电状态, 当前取值: Off、PoweringOff、On、PoweringOn
PowerCapacityWattsU32只读变更广播板卡NPU芯片-额定功耗
PowerConsumedWattsU16只读变更广播板卡NPU芯片-实际功耗
VoltU32只读变更广播npu电压,单位nV
PowerU16只读变更广播功耗,单位W
VRDChipTempU16只读变更广播VRD chip温度
BDFString只读变更广播BDF编号
RootBDFString只读变更广播芯片BDF
MemoryBandWidthU32只读变更广播板卡NPU芯片-额定带宽
ReadingCelsiusU16只读变更广播板卡NPU芯片-实际温度
IerrU8只读变更广播NPU宕机异常汇聚信号 0:正常 1:异常
PredictiveFaultU8读写变更广播预故障告警状态
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
ECCAlarmStatusU8只读变更广播NPU ECC错误告警状态 2-严重告警(NPU ECC历史计数超门限值64) 1-事件 (NPU ECC历史计数超门限值32) 0-NPU ECC历史计数超门限值的情况未发生
IErrFlagU32只读变更广播NPU宕机异常汇聚信号 0:正常 1:异常
VendorIDU16只读变更广播槽位号
VersionString只读变更广播版本
DriverVersionString只读变更广播驱动版本
FaultCodeString只读变更广播NPU带内故障码
PowerCapWattsU16只读变更广播NPU模组功耗封顶值,单位W
TotalCoresU32只读变更广播NPU核数
LocationString只读变更广播NPU所属抽屉信息
FlashIdsU64[]只读变更广播NPU的flashid列表
SlotU8只读变更广播NPU的物理槽位信息
HBMSingleBitIsolatedPagesU32只读变更广播HBM 单Bit错误隔离次数
HBMMultiBitIsolatedPagesU32只读变更广播HBM 多Bit错误隔离次数

==方法==


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字符串格式

DumpLog

收集NPU运行或者黑匣子日志

参数

  • LogType: String[] - 日志类型,支持的日志类型包括:Blackbox、Device
  • OutputFilePath: String - 日志导出路径,支持本地导出、远程导出

返回值

  • TaskId: U32 - 收集日志的任务ID

bmc.kepler.Systems.Processor.NPUs

==方法==


DumpNpuLog

收集NPU日志

参数

  • NpuId: U8 - NPU芯片编号

返回值

  • TaskId: U32 - 收集日志的任务ID

bmc.kepler.Systems.Processor.ProcessorMetrics

==属性==

属性名类型可读写信号通知描述
BandwidthPercentU8只读变更广播占用率
BandwidthThresholdPercentU8只读变更广播占用率门限
ConsumedPowerWattU32只读变更广播功耗

==方法==


SetBandwidthThreshold

设置Cpu占用率门限

参数

  • BandwidthThresholdPercent: U8 - Cpu占用率门限

返回值

  • Result: S32 - 设置Cpu占用率门限结果

GetBandwidthHistory

获取Cpu占用率的历史数据

返回值

  • History: String - Cpu占用率的历史数据

ClearBandwidthHistory

清除Cpu占用率的历史数据


bmc.kepler.Systems.Product

==属性==

属性名类型可读写信号通知描述
ProductNameString只读变更广播产品名称
ProductAliasString读写变更广播产品别名
ProductPictureString只读变更广播产品web界面展示图片名称
ProductVendorIDString只读变更广播产品厂商ID
ProductIdU32只读变更广播产品ID
ProductUniqueIDString只读变更广播产品唯一识别ID
ProductVersionString读写变更广播产品版本
LanguageSetString[]读写变更广播当前开启的语言集

==方法==


RetireSystem

产品报废处置

参数

  • PreserveLog: Boolean - 是否保存报警、维护和故障诊断日志

返回值

  • TaskId: U32 - 任务标识

GetRetirementStatus

获取报废处置任务状态信息

返回值

  • Status: String - 整体任务状态
  • Progress: U8 - 整体任务进度
  • Details: TaskStateDict - 子任务状态信息

==自定义类型==


TaskStateDict: 结构体类型

  • key: String - 子任务名称
  • value: String - 子任务状态

bmc.kepler.Systems.Product.Custom

==属性==

属性名类型可读写信号通知描述
OemDataU8[]读写变更广播第三方共享信息,对外提供设置和查询接口
ManufacturerString读写变更广播定制化厂商名称, redfish接口OEM厂商字段, 默认为Huawei, 中移动定制修改为Public
SmsNameString读写变更广播带内管理软件名称, 默认iBMA
ManufacturerOidString读写变更广播定制化厂商Oid, snmp接口Oid厂商字段, 默认为2011.2.235.1.1
CustomerRedfishVersionString读写变更广播客户Redfish规范版本信息,默认为空

bmc.kepler.Systems.Product.Device

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播设备名称
SerialNumberString只读变更广播设备序列号
OwnerIdString只读变更广播设备所有者ID

bmc.kepler.Systems.Product.DigitalWarranty

==属性==

属性名类型可读写信号通知描述
StartPointString读写变更广播服务起始时间, 用户可配置, 默认生产日期生成的服务起始时间为1996-04-10
LifespanU8读写变更广播服务年限,用户可配置
FirstPowerOnTimeString只读变更广播服务器首次上电时间, 根据生产日期生成, 格式为: YYYY-MM-DD

bmc.kepler.Systems.Pump

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播泵ID
SlotU8只读变更广播槽位
ModelString只读变更广播型号
PartNumberString只读变更广播部件号
ExpectedPWMDouble只读变更广播预期的PWM值
ActualPWMDouble只读变更广播实际PWM值
MaxSupportedPWMU32只读变更广播泵全速额定PWM值
SpeedRPMU16只读变更广播泵转速(转/分钟)
MaxSpeedRPMU32只读变更广播泵全速额定转速(转/分钟)
PresenceU8只读变更广播1在位,0不在位
StatusU8只读变更广播泵状态,0:正常,1:转速异常,2:在位异常,3:停转

bmc.kepler.Systems.Pumps

==属性==

属性名类型可读写信号通知描述
WorkInStandbyU8只读变更广播standby下是否可以运转

==方法==


SetPWM

设置所有泵转速

参数

  • PWM: Double[] - 要设置的转速占空比数组

返回值

  • Result: U8 - 返回结果,0:设置成功;1:设置失败

bmc.kepler.Systems.Retimer

==属性==

属性名类型可读写信号通知描述
ChipNameString只读变更广播芯片名称
ChipTypeU8只读变更广播芯片类型:0为5902L、1为5902H、2为5901、3为ds280
FirmwareVersionString只读变更广播retimer版本号
ChipLocationString只读变更广播芯片位置号(丝印)
TemperatureCelsiusS16只读变更广播retimer的温度
DieIDString只读变更广播芯片 DIEID
HealthStatusU8只读变更广播芯片健康状态:0为正常,1为异常

bmc.kepler.Systems.SecureBootOptions

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
CertificateExpiredU8只读变更广播证书过期标记

==方法==


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

==属性==

属性名类型可读写信号通知描述
PresenceU8只读变更广播在位情况
HealthU8只读变更广播健康状态
ProtocolString只读变更广播协议类型
ManufacturerString只读变更广播厂商名称
ProtocolVersionString只读变更广播协议版本
FirmwareVersionString只读变更广播固件版本

bmc.kepler.Systems.SmBios

==属性==

属性名类型可读写信号通知描述
SerialNumberString只读变更广播SmBios序列号
VersionString只读变更广播SmBios版本
SKUNumberString只读变更广播SmBios SKU编号
FamilyString只读变更广播处理器家族
SmBiosStatusU8只读变更广播SmBios状态
SmBiosUpdatedFlagU8只读变更广播SmBios状态更新标记
FileChangeU8只读变更广播SmBios文件变化标记
FileNameString只读变更广播SmBios文件名
DiffFileNameString只读变更广播SmBios差异文件名
SystemIdU8只读变更广播系统Id

bmc.kepler.Systems.SmartProvision

==属性==

属性名类型可读写信号通知描述
MajorVersionString只读变更广播SmartProvision主版本号
MinorVersionString只读变更广播SmartProvision次版本号
LogicalDriveStateAbnormalU8只读变更广播系统中逻辑盘的状态,存在异常状态的逻辑盘时为1,不存在时为0

bmc.kepler.Systems.Sms

==属性==

属性名类型可读写信号通知描述
ChannelTypeU8只读变更广播通道类型,0:虚拟网卡 1:字符设备 2:USB
IdU8只读变更广播系统ID
RegisteredBoolean只读变更广播注册状态
NameString只读变更广播带内代理注册的名字
VersionString只读变更广播带内代理的版本号
TypeString只读变更广播带内代理注册的类型
IsSupportedBoolean只读变更广播带内代理使能状态,主要用于前端显示
WhiteListString只读变更广播带内代理设置的白名单,决定了那些接口可以透传
DriverVersionString只读变更广播带内代理驱动版本号,主要用于前端显示
CdevChannelEnabledBoolean只读变更广播字符设备通道打开关闭,默认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

==属性==

属性名类型可读写信号通知描述
LocalPortU16只读变更广播BMC作为客户端,且通道不为Veth时,net_nat服务监听的本地回环口的端口
ServerPortU16只读变更广播BMC作为客户端时,BMA作为服务端的端口号
ServiceTypeString只读变更广播服务类型可选参数,可选:Snmp,Https

bmc.kepler.Systems.Sms.AgentPorts

==属性==

属性名类型可读写信号通知描述
ServerMaxPortU16读写变更广播BMC作为客户端,通道为VETH时,BMA为服务端的最大端口号
ServerMinPortU16读写变更广播BMC作为客户端,通道为VETH时,BMA为服务端的最大端口号

bmc.kepler.Systems.Sms.SmsStatus

==属性==

属性名类型可读写信号通知描述
RunningStateString只读变更广播Sms运行状态,用于前端页面展示
UpdateStateU8只读变更广播Sms资源更新状态,0:no start 1:update complete 2:update default
StateU8只读变更广播带内代理状态,0:正常 1:异常
HeartBeatStateU8只读变更广播心跳状态,0:正常 1:异常

bmc.kepler.Systems.Sms.Veth

==属性==

属性名类型可读写信号通知描述
PortU32只读变更广播带内代理支持的虚拟网口端口
IpAddrString只读变更广播带内代理支持的虚拟网口的IP端口
ProtocolTypeU8只读变更广播带内协议类型, 0表示HTTP, 1表示HTTPS, 默认是 HTTPS 协议

bmc.kepler.Systems.Storage.Battery

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播BBU名称
StateU8只读变更广播BBU在位信息
FaultU8只读变更广播BBU故障标志
HealthStatusU32只读变更广播bit0:电压过低,bit1:需要更换BBU,bit2:电量校准失败,bit3:电量校准超时,bit4:预故障,bit5:剩余容量低,bit6:没有用于缓存卸载的空间,others:resrved
HealthU8只读变更广播BBU健康状态
TemperatureCelsiusS16只读变更广播BBU温度

bmc.kepler.Systems.Storage.Controller

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播控制器Id, 由软件生成,默认值0xFF
TypeString只读变更广播控制器类型
NameString只读变更广播控制器名称
TemperatureCelsiusS16只读变更广播控制器芯片温度
TemperatureAbnormalU8只读变更广播温度异常描述,温度获取失败时置1
OOBSupportU8只读变更广播支持带外管理模式,0:不支持带外;1:支持带外
FirmwareVersionString只读变更广播控制器固件版本
SupportedModeString[]只读变更广播控制器工作模式
MemorySizeMiBU16只读变更广播控制器内存大小,单位MB
DeviceInterfaceString只读变更广播控制器设备接口
SASAddrString只读变更广播控制器SAS地址
SerialNumberString只读变更广播控制器序列号
MaxStripSizeBytesU32只读变更广播控制器支持的最大条带
MinStripSizeBytesU32只读变更广播控制器支持的最小条带
NVDataVersionString只读变更广播控制器配置版本
MaintainPDFailHistroryU8只读变更广播是否启用控制器的物理盘故障记忆功能
PCIeLinkWidthString只读变更广播控制器的PCIE带宽
UnconfiguredDriveWriteCachePolicyString只读变更广播非RAID组成员盘的写缓存策略:Enabled,Disabled,Default
HBADriveWriteCachePolicyString只读变更广播HBA模式下硬盘的写缓存策略:Enabled,Disabled,Default
ConfiguredDriveWriteCachePolicyString只读变更广播RAID组成员盘的写缓存策略:Enabled,Disabled,Default
SupportedRAIDTypesString[]只读变更广播RAID级别
SmarterCopyBackStateU8只读变更广播RAID控制器在检测到物理盘SMART错误之后是否自动进行Copyback
CopyBackStateU8只读变更广播指定控制器的回拷功能使能状态
BootDevicesString[]只读变更广播控制器的启动设备列表
HardwareRevisionString只读变更广播控制器的硬件版本
HotSpareActivationModeString只读变更广播控制器的热备激活模式:Failure,Predictive,Unknown
NoBatteryWriteCacheEnabledU8只读变更广播控制器的无电池写缓存模式
ReadCachePercentU8只读变更广播控制器的读缓存百分比,取值范围:0~100
JBODStateU8只读变更广播控制器的JBOD功能状态:false,true
CachePinnedStateU8只读变更广播控制器的Cache Pinned开关
DDREccCountU16只读变更广播DDR ECC计数
WorkModeString只读变更广播控制器的工作模式, 包括RAID、HBA、JBOD和MIXED四种
RefDrivesString[]只读变更广播控制器下挂载的所有硬盘名
CryptoEraseSupportedBoolean只读变更广播驱动器是否支持加密盘数据擦除
EpdSupportedBoolean只读变更广播控制器是否支持启用硬盘模式增强
TypeIdU8只读变更广播控制器的类型Id
DeviceNameString只读变更广播对应的PCIeDevice的设备名
BOMNumberString只读变更广播BOM编码
PositionString只读变更广播对应的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的取值为0:RAID, 1:HBA, 2:RAID, 3:MIXED; ProfileId的取值为0

参数

  • 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

==属性==

属性名类型可读写信号通知描述
BatteryPresenceU8只读变更广播控制器下挂载的电池在位信息
BatteryFaultU8只读变更广播控制器下挂载的电池故障信息
BatteryHealthU8只读变更广播控制器下挂载的电池健康信息

bmc.kepler.Systems.Storage.Controller.Chip

==属性==

属性名类型可读写信号通知描述
ModelString只读变更广播raid卡芯片型号
ChipManufacturerString只读变更广播raid卡芯片厂商

bmc.kepler.Systems.Storage.Controller.ConsistencyCheck

==属性==

属性名类型可读写信号通知描述
StateU8只读变更广播RAID控制器一致性校验功能状态
PeriodOfHoursU16只读变更广播RAID控制器一致性校验周期,单位(小时), 取值范围[1:1440]
RateString只读变更广播RAID控制器一致性校验速率
AutoRepairEnabledU8只读变更广播RAID控制器一致性校验自修复开关
RunningStatusString只读变更广播RAID控制器一致性校验状态
TotalVolumeCountsU16只读变更广播RAID控制器一致性校验需要校验的总数量
CompletedVolumeCountsU16只读变更广播RAID控制器一致性校验运行已经完成的数量
DelayToStartU32只读变更广播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

==属性==

属性名类型可读写信号通知描述
FaultCodeU16只读变更广播控制器的故障码
CommunicationLossU8只读变更广播控制器通信丢失标志
HealthU8只读变更广播控制器健康状态
FaultCodeByBiosU8只读变更广播BIOS上报的硬件故障错误码。0:正常;非0:故障

bmc.kepler.Systems.Storage.Controller.Driver

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播控制器驱动器名称
VersionString只读变更广播控制器驱动器版本

bmc.kepler.Systems.Storage.Controller.VolumeManage

==属性==

属性名类型可读写信号通知描述
CreateVolumeSupportedBoolean只读变更广播控制器是否支持创建逻辑盘
SupportedReadPolicyListString[]只读变更广播支持的逻辑盘读策略列表
DefaultReadPolicyString只读变更广播默认的逻辑盘读策略
ReadPolicyWritableBoolean只读变更广播支持修改逻辑盘读策略
SupportedWritePolicyListString[]只读变更广播支持的逻辑盘写策略列表
DefaultWritePolicyString只读变更广播默认的逻辑盘写策略
WritePolicyWritableBoolean只读变更广播支持修改逻辑盘写策略
SupportedIOPolicyListString[]只读变更广播支持的逻辑盘IO策略列表
DefaultIOPolicyString只读变更广播默认的逻辑盘IO策略
IOPolicyWritableBoolean只读变更广播支持修改逻辑盘IO策略
SupportedAccessPolicyListString[]只读变更广播支持的逻辑盘访问策略列表
DefaultAccessPolicyString只读变更广播默认的逻辑盘访问策略
AccessPolicyWritableBoolean只读变更广播支持修改逻辑盘访问策略
SupportedDriveCachePolicyListString[]只读变更广播支持的逻辑盘硬盘缓存策略列表
DefaultDriveCachePolicyString只读变更广播默认的逻辑盘硬盘缓存策略
DriveCachePolicyWritableBoolean只读变更广播支持修改逻辑盘硬盘缓存策略

==方法==


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

==属性==

属性名类型可读写信号通知描述
PhyErrorEnabledBoolean读写变更广播PHY误码诊断使能
PhyErrorIntervalU32读写变更广播PHY误码数据采集的时间间隔,单位秒
PhyErrorMaxRecordU8读写变更广播PHY误码在一个OS启动周期内记录的最大条数(有增长的记录)
PhyErrorThresholdU32读写变更广播PHY误码单位时间增长过快的判断门限值
MaxPhyErrorLogFileRotationCountU8读写变更广播PHY误码循环记录的最大文件数
PhyErrorSelUnlimitFlagBoolean读写变更广播PHY误码是否允许产生多个SEL告警事件

bmc.kepler.Systems.Storage.DiskArray

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播RAID组的序号,由RAID卡读到
UsedSpaceMiBU32只读变更广播RAID组的已使用的空间
TotalFreeSpaceMiBU32只读变更广播RAID组的空闲空间
FreeBlocksSpaceMiBU32[]只读变更广播RAID组的空闲块容量列表
RefVolumesU16[]只读变更广播RAID组的关联逻辑盘列表,例:[145, 144]
RefDrivesString[]只读变更广播RAID组的关联物理盘列表,例:[Disk0, Disk1]
AverageDriveFreeSpaceMiBU32只读变更广播指定驱动器阵列中每个驱动器的剩余容量
DriveNumPerSpanU8只读变更广播驱动器阵列中每个Span的成员的个数
RAIDTypeString只读变更广播驱动器阵列组成的虚拟磁盘的级别
RefControllerIdU8只读变更广播RAID组关联的控制器ID

bmc.kepler.Systems.Storage.DiskPartition

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播os盘符
UsageU8只读变更广播磁盘分区利用率
TotalCapacityGiBDouble只读变更广播硬盘分区总容量
UsedCapacityGiBDouble只读变更广播硬盘分区当前使用容量

bmc.kepler.Systems.Storage.Drive

==属性==

属性名类型可读写信号通知描述
NodeIdString只读变更广播资源的唯一Id
IdU8只读变更广播硬盘Id, 由软件生成,默认值0
SlotNumberU8只读变更广播硬盘槽位号
NameString只读变更广播硬盘名称,Disk1,NMVeDisk1等
PresenceU8只读变更广播硬盘在位状态,0不在位,1在位
CapacityMiBU32只读变更广播硬盘容量,以MiB为单位
TemperatureCelsiusS16只读变更广播硬盘温度,硬盘存在零下负温场景
ModelString只读变更广播硬盘型号,比如MBF2300RC
EnclosureIdU16只读变更广播硬盘所在背板的id,由控制器分配
LocationIndicatorStateU8只读变更广播硬盘定位状态,根据locate寄存器和fault寄存器判断
LocateLedU8只读变更广播硬盘locate寄存器的值
FaultLedU8只读变更广播硬盘fault寄存器的值
ProtocolU8只读变更广播硬盘接口类型:0:Unknown,1:parallel.SCSI,2:SAS,3:SATA,4:FC
CapableSpeedGbsU8只读变更广播硬盘接口速率(最大速率)
NegotiatedSpeedGbsU8只读变更广播硬盘连接速率(协商速率)
MediaTypeU8只读变更广播硬盘介质类型:0:HDD,1:SSD,2:SSM,255:Unknown
FirmwareStatusU8只读变更广播硬盘固件状态
SerialNumberString只读变更广播硬盘序列号
ManufacturerString只读变更广播硬盘厂商
PowerOnHoursDouble只读变更广播硬盘通电时间
RevisionString只读变更广播硬盘固件版本
RotationSpeedRPMU16只读变更广播硬盘转速
BlockSizeBytesU16只读变更广播硬盘块大小
SASAddress1String只读变更广播硬盘SAS地址的第一部分
SASAddress2String只读变更广播硬盘SAS地址的第二部分
PredictedMediaLifeLeftPercentU8只读变更广播硬盘剩余磨损率,即剩余擦写次数的百分比(0-100,或者255表示无效)
PredictedFailCountU32只读变更广播硬盘预故障错误统计
MediaErrorCountU32只读变更广播硬盘媒介错误统计
OtherErrorCountU32只读变更广播硬盘其他错误统计
PatrolStateU8只读变更广播硬盘巡检状态:0:没有巡检或巡检结束,1:巡检中,255:未知
PowerStateU8只读变更广播硬件电源状态
RebuildStateU8只读变更广播硬盘重构状态:0:没有重建或重建结束,1:重建中,255:未知
RebuildProgressU8只读变更广播硬盘重构进度
BootPriorityU8只读变更广播硬盘启动盘优先级
HotspareTypeU8只读变更广播硬盘热备状态
RefControllerIdU8只读变更广播关联的控制器Id
RefVolumeListU16[]只读变更广播关联的逻辑盘Id列表
RefDiskArrayIdU16只读变更广播关联的硬盘阵列Id
ManufacturerIdU32只读变更广播厂商Id
PCIeLinkSpeedDouble只读变更广播PCIe单个通道的速率
LocationString只读变更广播表示当前盘的物理位置
DeviceNameString只读变更广播表示当前盘的设备名称
ResourceIdU8只读变更广播表示当前盘的资源归属

==方法==


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

==属性==

属性名类型可读写信号通知描述
TypeString只读变更广播硬盘的丝印类型
SocketIdU8只读变更广播硬盘的CPU归属
SlotIdU8只读变更广播硬盘的槽位号
PortIdU8只读变更广播硬盘的端口号
RootBDFString只读变更广播硬盘的BDF

bmc.kepler.Systems.Storage.Drive.DriveStatus

==属性==

属性名类型可读写信号通知描述
MissingU16只读变更广播硬盘丢失标志
PredictiveFailureU8只读变更广播预故障标志
InAFailedArrayU8只读变更广播是否处于一个故障的硬盘阵列。0:否,1:是
CapacityErrorBoolean只读变更广播硬盘容量是否异常
FirmwareStatusErrorBoolean只读变更广播硬盘固件状态是否异常
FailureBoolean只读变更广播硬盘是否故障
HealthU8只读变更广播硬盘健康状态

bmc.kepler.Systems.Storage.Drive.DriveSubHealth

==属性==

属性名类型可读写信号通知描述
EstimatedRemainingLifespanInsufficientU8只读变更广播硬盘预估剩余寿命不足
SLCSpareBlockPercentageU8只读变更广播非用户区剩余冗余块百分比
TLCSpareBlockPercentageU8只读变更广播用户区剩余冗余块百分比
EstimatedRemainingLifespanU32只读变更广播硬盘预估剩余寿命
IODeteriorationHealthCodeU16只读变更广播硬盘IO性能健康码

bmc.kepler.Systems.Storage.Drive.NVMe

==属性==

属性名类型可读写信号通知描述
LifeUsedPercentageU8只读变更广播驱动器寿命百分比

==方法==


GetSmartInfo

通过标准NVMe-mi协议获取SMART/Health Information

参数

  • Vendor: U16 - 指定smart信息为标准协议还是自定义,标准格式传0,自定义传厂商自定义标识

返回值

  • MessageResponse: U8[] - 响应报文, 小端字节序排列

SendNvmeMICommand

按照标准NVMe-mi协议发送NVMe-MI Command格式命令,请求参数可以参照协议第5章Management Interface Command Set的请求报文填充

参数

  • Opcode: U8 - 该字段指定要处理的NVMe-MI Command格式的操作码
  • Dword0: U32 - 该字段为特定命令的 Dword 0
  • Dword1: U32 - 该字段为特定命令的 Dword 1
  • RequestData: U8[] - 预留请求字节, 小端字节序排列

返回值

  • Status: U8 - 该字段为命令的响应码
  • NVMeResponse: U32 - 该字段为特定命令响应
  • ResponseData: U8[] - 预留响应字节, 小端字节序排列

GetTelemetryData

通过标准NVMe-mi协议获取Telemetry Host/Controller-initiated

参数

  • DataType: String - 指定收集硬盘host或controller的日志,取值范围:Host/Controller

返回值

  • TaskId: U32 - 任务标识

GetIdentifyData

通过标准NVMe-mi协议获取Identify command信息

参数

  • CNSValue: U8 - 指定Controller or Namespace Structure决定该命令返回的数据结构,参考协议的Identify – CNS Values图表定义

返回值

  • MessageResponse: U8[] - 响应报文, 小端字节序排列

bmc.kepler.Systems.Storage.Drive.NVMe.SMART

==属性==

属性名类型可读写信号通知描述
AvailableSpareU8只读变更广播驱动器可用冗余空间的百分比(0到100)
CriticalWarningU8只读变更广播控制器状态的重要的告警,bit0:表示冗余空间小于设定的阈值,bit1:表示温度超过或低于一个重要的阈值,bit2:表示由于重要的media错误,器件的可靠性已经降低,bit3:该介质已经被置为只读模式,bit4:表示控制器的易失性器件fail,该域仅在控制器内部存在易失性器件时有效,bit5-7:保留
UsedPercentageU8只读变更广播用户实际使用和厂家设定的器件寿命的百分比(0到100)
StatusU8只读变更广播SMART告警状态

bmc.kepler.Systems.Storage.Drive.SAS.SMART

==属性==

属性名类型可读写信号通知描述
StripTemperatureCelsiusU32只读变更广播驱动器条带温度(摄氏度)
ElementsInGrownDefectListU32只读变更广播增长缺陷列表(G表)中的元素
ElementsInPrimaryDefectListU32只读变更广播主缺陷列表(P表)中的元素
ManufacturedInWeekOfYearString只读变更广播生产日期:年中周
BlocksSentToInitiatorU32只读变更广播发送到启动器的块
BlocksReceivedFromInitiatorU32只读变更广播从启动器收到的块
UntilNextInterSMARTTestMinutesU32只读变更广播距下一次内部SMART测试的时长(分钟)
LastPrefailEventSeqNumU32只读变更广播最后一次预测故障事件的序列号

bmc.kepler.Systems.Storage.Drives

==属性==

属性名类型可读写信号通知描述
MaxTemperatureCelsiusU8只读变更广播驱动器最高温度,用于风扇调速
LogAutoCollectEnableBoolean读写变更广播硬盘日志自动收集开启状态
LogAutoCollectIntervalU8读写变更广播硬盘日志自动收集周期

==方法==


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性能健康码)

StartCollectLog

手动触发收集硬盘日志

参数

  • DriveName: String - 硬盘名称

==自定义类型==


DriveList: 结构体类型

  • key: U32
  • value: DiagInfoList

DiagInfoList: 结构体类型

  • key: String
  • value: String

KeyValueTable: 结构体类型

  • Key: String
  • Value: String

bmc.kepler.Systems.Storage.PhyError

==属性==

属性名类型可读写信号通知描述
PhyIdU8只读变更广播PHY误码Id
InvalidDwordCountU32只读变更广播无效DWORD数
LossDwordSyncCountU32只读变更广播丢失DWORD同步数
PhyResetProblemCountU32只读变更广播PHY重启问题数
RunningDisparityErrorCountU32只读变更广播连续不均衡性错误数

bmc.kepler.Systems.Storage.SASMetrics

==属性==

属性名类型可读写信号通知描述
ControllerIdU8只读变更广播关联的控制器序号
InvalidDwordCountU32只读变更广播无效DWORD数
LossDwordSyncCountU32只读变更广播丢失DWORD同步数
PhyResetProblemCountU32只读变更广播PHY重启问题数
RunningDisparityErrorCountU32只读变更广播连续不均衡性错误数

bmc.kepler.Systems.Storage.StorageConfig

==属性==

属性名类型可读写信号通知描述
StorageConfigReadyU8只读变更广播用于控制器配置导入导出场景,标志了所有控制器的状态
VolumesStateAbnormalU8只读变更广播是否存在状态异常的逻辑盘。0:否,1:是
DiskPartitionUsagePercentageThresholdU8读写变更广播磁盘分区占用率告警阈值(百分比)

bmc.kepler.Systems.Storage.Volume

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播逻辑盘的Id
VolumeNameString只读变更广播逻辑盘的名称
OptimumIOSizeBytesU32只读变更广播逻辑盘的条带大小
DefaultReadPolicyString只读变更广播逻辑盘的默认读策略
DefaultWritePolicyString只读变更广播逻辑盘的默认写策略
StateU8只读变更广播逻辑盘的状态
RAIDTypeU8只读变更广播逻辑盘的Raid级别
CapacityBytesU64只读变更广播逻辑盘的容量
DriveCachePolicyU8只读变更广播逻辑盘的硬盘缓存策略
CurrentForegroundInitStateU8只读变更广播逻辑盘当前是否在FGI中
ForegroundInitProgressU8只读变更广播逻辑盘当前的FGI进度,百分比
CurrentReadPolicyString只读变更广播逻辑盘当前读策略
CurrentWritePolicyString只读变更广播逻辑盘当前写策略
BootPriorityU8只读变更广播启动优先级
BootEnableU8只读变更广播是否为启动盘
OSDriveNameString只读变更广播逻辑盘对应的OS盘符
BGIEnableU8只读变更广播后台初始化使能状态
SSDCachecadeVolumeU8只读变更广播是否为CacheCade逻辑盘
ConsistencyCheckU8只读变更广播一致性检查功能的启用状态
SSDCachingEnableU8只读变更广播是否可使用CacheCade逻辑盘
AssociatedVolumesU16[]只读变更广播所关联的普通逻辑盘的访问路径
AssociatedCacheCadeVolumeU16[]只读变更广播所关联的CacheCade逻辑盘的访问路径
DefaultCachePolicyString只读变更广播逻辑盘默认的Cache策略
AccessPolicyString只读变更广播逻辑盘的访问策略
CurrentCachePolicyString只读变更广播逻辑盘当前Cache策略
CacheLineSizeKiBU8只读变更广播缓存行大小
AccelerationMethodString只读变更广播加速方法
RebuildProgressU8只读变更广播指定逻辑盘数据重建进度
InitializationModeU8只读变更广播初始化模式
RebuildStateU8只读变更广播指定逻辑盘数据重建状态
RefControllerIdU8只读变更广播指定逻辑盘所属控制器id
RefDriveListString[]只读变更广播指定逻辑盘关联的物理盘列表
RefDiskArrayListU16[]只读变更广播指定逻辑盘关联的阵列列表
HotSpareDriveListString[]只读变更广播逻辑盘关联热备盘列表
SpanCountU8只读变更广播逻辑盘包含的子组数
MaxResizableSizeBytesU64只读变更广播逻辑盘的最大可设置的容量

==方法==


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

==属性==

属性名类型可读写信号通知描述
KBCErrorU8只读变更广播KBC Controller自检错误
VideoErrorU8只读变更广播显卡芯片异常

bmc.kepler.Systems.SystemLockDown

==属性==

属性名类型可读写信号通知描述
SystemLockDownSupportString读写变更广播产品是否支持系统锁定功能,通过license控制其状态
SystemLockDownStatusString读写变更广播系统锁定开关状态

bmc.kepler.Systems.TPCM.Component

==属性==

属性名类型可读写信号通知描述
ActualManufacturerString只读变更广播实际部件厂商
ActualModelString只读变更广播实际部件型号
ActualUniqueIdentifierString只读变更广播实际部件唯一标识
StandardManufacturerString只读变更广播基准部件厂商
StandardModelString只读变更广播基准部件型号
StandardUniqueIdentifierString只读变更广播基准部件唯一标识
StatusU8只读变更广播部件状态,0-正常,1-新增,2-移除,3-变更

bmc.kepler.Systems.TemperatureManagement

==属性==

属性名类型可读写信号通知描述
SensorLocationSupportedBoolean只读变更广播是否支持温度海洋界面显示

==方法==


GetTemperaturesInfo

获取温度点信息

返回值

  • TemperaturesInfo: Array - 温度点信息

==自定义类型==


TemperaturesInfo: 结构体类型

  • Name: String - 温度点名称
  • ReadingValue: Double - 温度值
  • Status: String - 告警状态
  • UpperThreshold: U8[] - 告警阈值上限(轻微/严重/致命)
  • LowerThreshold: U8[] - 告警阈值下限(轻微/严重/致命)
  • CoordinateX: U8 - 温度点横坐标
  • CoordinateY: U8 - 温度点纵坐标

bmc.kepler.Systems.ThresholdSensor

==属性==

属性名类型可读写信号通知描述
EntityIdU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Id
EntityInstanceU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Instance
CapabilitiesU8只读变更广播传感器支持能力,来自于IPMI规范,具体可以参考规范 43.1
SensorTypeU8只读变更广播传感器类型,来自于IPMI规范,具体可以参考规范 42.2
SensorIdentifierString只读变更广播传感器标识
SensorNameString只读变更广播传感器对外显示名称
ReadingMaskU16只读变更广播传感器读值掩码,来自于IPMI规范,具体可以参考规范 43.1
UpperNonrecoverableU8只读变更广播传感器紧急事件上限,来自于IPMI规范,具体可以参考规范 43.1
UpperCriticalU8只读变更广播传感器严重事件上限,来自于IPMI规范,具体可以参考规范 43.1
UpperNoncriticalU8只读变更广播传感器一般事件上限,来自于IPMI规范,具体可以参考规范 43.1
LowerNonrecoverableU8只读变更广播传感器紧急事件下限,来自于IPMI规范,具体可以参考规范 43.1
LowerNoncriticalU8只读变更广播传感器严重事件下限,来自于IPMI规范,具体可以参考规范 43.1
LowerCriticalU8只读变更广播传感器一般事件下限,来自于IPMI规范,具体可以参考规范 43.1
PositiveHysteresisU8只读变更广播传感器正向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
NegativeHysteresisU8只读变更广播传感器负向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
OwnerLunU8只读变更广播传感器的Lun,默认0,来自于IPMI规范,具体可以参考规范 43.1
SensorNumberU8只读变更广播传感器编号,默认255,来自于IPMI规范,由BMC自行生成;如果需要特殊的编号,则需要单独在传感器定制化进行定制(BMC正常运行时插入的部件的传感器不支持定制)
ReadingU8只读变更广播传感器原始读值,引用传感器的数据源(如Scanner)读值同步,需要填写一个默认值,用于数据源未更新时显示,需要注意在门限之内,防止产生SEL事件
ReadingStatusU8只读变更广播传感器读值状态,默认0,引用传感器的数据源(如Scanner)读值状态同步
OriginalReadingDouble只读变更广播传感器的原始值,当线型标志配置0x70-0x7f时,需要此属性配合Reading(固定配置170)计算传感器读数系数以提升读值精度至1w

bmc.kepler.Systems.ThresholdSensorDisplay

==属性==

属性名类型可读写信号通知描述
UpperNonrecoverableDisplayString只读变更广播传感器紧急门限上限可读描述,精度3位有效数字
UpperCriticalDisplayString只读变更广播传感器严重门限上限可读描述,精度3位有效数字
UpperNoncriticalDisplayString只读变更广播传感器一般门限上限可读描述,精度3位有效数字
LowerNonrecoverableDisplayString只读变更广播传感器紧急门限下限可读描述,精度3位有效数字
LowerNoncriticalDisplayString只读变更广播传感器严重门限下限可读描述,精度3位有效数字
LowerCriticalDisplayString只读变更广播传感器一般门限下限可读描述,精度3位有效数字
PositiveHysteresisDisplayString只读变更广播传感器正向迟滞量可读描述,精度3位有效数字
NegativeHysteresisDisplayString只读变更广播传感器负向迟滞量可读描述,精度3位有效数字
ReadingDisplayString读写变更广播传感器读值可读描述,精度3位有效数字
UnitDisplayString只读变更广播传感器单位可读描述
StatusString只读变更广播传感器当前状态:Enabled:传感器使能;Disabled:传感器禁用;InTest:传感器测试中;Starting:传感器更新中
HealthString只读变更广播传感器健康状态:Critical:紧急;Major:严重;Minor:一般;OK:正常
AssertStatusU16只读变更广播传感器SEL事件状态,16进制的数,bit4 - bit15依次对应12种门限事件状态,1:Assert;0:Deassert

bmc.kepler.Systems.UnitConfigError

==属性==

属性名类型可读写信号通知描述
Port1LinkInfoString读写变更广播端口1连接信息
Port1StatusU8读写变更广播端口1状态(0: 初始状态、1: 匹配成功、2: 线缆连接错误、3: 组件不在白名单、4: 组件uid无法获取、5: 组件连接不完整、255: 不告警)
Port2LinkInfoString读写变更广播端口2连接信息
Port2StatusU8读写变更广播端口2状态(0: 初始状态、1: 匹配成功、2: 线缆连接错误、3: 组件不在白名单、4: 组件uid无法获取、5: 组件连接不完整、255: 不告警)
AbsenceAllowedU8只读变更广播是否允许组件设备不在位(0:不允许不在位,当不在位时产生该告警、1:允许不在位,不产生告警)

bmc.kepler.Systems.VrdChip

==属性==

属性名类型可读写信号通知描述
NameString读写变更广播芯片名称 Type+No
VendorString读写变更广播芯片厂商
TypeString读写变更广播芯片类型
FirmwareVersionString读写变更广播固件版本

bmc.kepler.Systems.VrdMgmt

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
HealthU8只读变更广播健康状态
StatusU8只读变更广播Vrd值为无效值时,Status置为0,有效值时,置位为1
CpuIdU8只读变更广播所关联的CPU id
Cpu0v9TACoreDouble读写变更广播Vrd供电信息,供电区域类型为CORE,DieId为1
Cpu0v75DDRVDDDouble读写变更广播Vrd供电信息,供电区域类型为DDR,无DieId
Cpu0v9TBCoreDouble读写变更广播Vrd供电信息,供电区域类型为CORE,DieId为3
Cpu0v9UncoreDouble读写变更广播Vrd供电信息,供电区域类型为UNCORE,无DieId
Cpu0v8NADVDDDouble读写变更广播Vrd供电信息,供电区域类型为Nimbus,DieId为0
Cpu0v8NBDVDDDouble读写变更广播Vrd供电信息,供电区域类型为Nimbus,DieId为2
Cpu1v1DDRVddqDouble读写变更广播Vrd供电信息,供电区域类型为VDDQ,无DieId
CpuTACoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为CORE,DieId为1
CpuDDRVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为DDR,无DieId
CpuTBCoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为CORE,DieId为3
CpuUncoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为UNCORE,无DieId
CpuNADVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为Nimbus,DieId为0
CpuNBDVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为Nimbus,DieId为2
CpuDDRVddqTempDouble读写变更广播临时Vrd供电信息,供电区域类型为VDDQ,无DieId
VrdTemperatureCelsiusDouble只读变更广播Vrd温度,用作调速
WattsDouble读写变更广播功率

bmc.kepler.Systems.VrdPower

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统id
CpuIdU8只读变更广播cpu index取值范围为0 ~ n
TypeU8只读变更广播电源供电区域类型, 0: Core, 1: Uncore, 2: DDr, 3: Nimbus, 4: VDDQ
DieIdU8只读变更广播电源供电die区域, 0: NA, 1: TA, 2: NB, 3: TB, 255: 不涉及
VoltageDouble只读变更广播电源电压,单位 V
CurrentAmpsDouble只读变更广播电源电流,单位 A
TemperatureCelsiusDouble只读变更广播电源温度,单位℃

bmc.kepler.TaskService.Task

==属性==

属性名类型可读写信号通知描述
IdU32只读变更广播任务id
NameString只读变更广播任务名称
StartTimeString只读变更广播任务开始时间
EndTimeString只读变更广播任务结束时间
ProgressU32只读变更广播任务进度
StateString只读变更广播任务的状态
StatusString只读变更广播任务的级别
ParametersString只读变更广播消息参数说明
MessageIdString只读变更广播消息id
MessageArgsString[]只读变更广播消息参数

bmc.kepler.TelemetryService

==属性==

属性名类型可读写信号通知描述
MaxReportsU8只读变更广播TelemetryService服务支持的最大MetricReport数
MinCollectionIntervalString只读变更广播TelemetryService服务支持最小采集间隔
ServiceEnabledBoolean读写变更广播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

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播MetricReportDefinition的Id
NameString只读变更广播MetricReportDefinition的名称
DescriptionString只读变更广播MetricReportDefinition的描述
AppendLimitU16只读变更广播单个MetricReport允许记录数据的最大条数
MetricReportDefinitionEnabledBoolean读写变更广播MetricReportDefinition的使能状态,关闭后自身和Trigger触发都不再产生MetricReport
MetricReportDefinitionTypeString读写变更广播产生MetricReport的方式:OnChange-采集项取值变化时产生;OnRequest-查询MetricReport时产生;Periodic-周期性产生,需要指定Schedule
MetricsArray读写变更广播呈现在MetricReport中的采集项定义列表
ReportActionsString[]读写变更广播产生新的MetricReport之后需要做的动作,LogToMetricReportsCollection-记录在对应MetricReport资源中;RedfishEvent-通过redfish事件上报给订阅者
ReportUpdatesString读写变更广播用于指定当单个MetricReport达到容量上限之后如何更新后续的Report,AppendWrapsWhenFull-使用新记录覆盖旧记录
InitialStartTimeU64读写变更广播Schedule配置,采集起始时间
LifetimeString读写变更广播Schedule配置,采集数据的最大时长
MaxOccurrencesU32读写变更广播Schedule配置,最大采集次数
RecurrenceIntervalString读写变更广播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

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播Triggers的Id
NameString只读变更广播Triggers的名称
DescriptionString只读变更广播Triggers的描述
MetricReportDefinitionsString[]读写变更广播TriggersActions属性包含RedfishMetricReport时,Triggers门限条件触发,需要生成的MetricReport的定义集合
MetricIdsString[]读写变更广播Triggers关联的MetricDefinition的Id集合
MetricTypeString只读变更广播Triggers的支持的指标类型,Numeric-数值型
LowerCriticalActivationString读写变更广播触发LowerCritical阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
LowerCriticalDwellTimeString读写变更广播触发LowerCritical阈值迟滞时间
LowerCriticalReadingDouble读写变更广播LowerCritical阈值
LowerWarningActivationString读写变更广播触发LowerWarning阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
LowerWarningDwellTimeString读写变更广播触发LowerWarning阈值迟滞时间
LowerWarningReadingDouble读写变更广播LowerWarning阈值
UpperCriticalActivationString读写变更广播触发UpperCritical阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
UpperCriticalDwellTimeString读写变更广播触发UpperCritical阈值迟滞时间
UpperCriticalReadingDouble读写变更广播UpperCritical阈值
UpperWarningActivationString读写变更广播触发UpperWarning阈值的方式:Increasing-超过阈值;Decreasing-低于阈值;Either-都触发;Disabled-不触发
UpperWarningDwellTimeString读写变更广播触发UpperWarning阈值迟滞时间
UpperWarningReadingDouble读写变更广播UpperWarning阈值
TriggerActionsString[]只读变更广播Triggers触发时的操作
TriggerEnabledBoolean读写变更广播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

==属性==

属性名类型可读写信号通知描述
UpgradeKeyDomainIdU32只读变更广播固件升级解包使用的密钥的domain id
UpgradingFlagBoolean只读变更广播标识当前是否存在升级任务
ParallelSupportedBoolean只读变更广播标识当前版本是否支持并行升级
UpgradeModeString只读变更广播标识当前升级模式

==方法==


StartUpgrade

启动固件升级接口

参数

  • FilePath: String - 升级包路径
  • AdditionalOptions: Object - 固件升级可选参数,用于各种升级扩展场景

返回值

  • TaskId: U32 - 升级任务ID

ParallelUpdate

启动固件并行升级接口

参数

  • UpgradeOptions: Object - 固件并行升级可选参数,对所有Package都生效
  • Packages: Array - 固件并行升级请求列表,每个元素描述一个升级子任务

返回值

  • TaskId: U32 - 并行升级主任务ID
  • SubTaskIds: U32[] - 并行升级子升级任务ID列表

PrepareReply

回复prepare动作结果

参数

  • SystemId: S32 - 系统ID
  • FirmwareType: String - 固件的类型信息,由固件管理统一分配管理
  • VersionStr: String - 版本字符串
  • PrepareResult: S32 - 准备结果
  • AdditionalOptions: Object - 固件升级扩展可选参数字典,用于并行升级等扩展场景

ProcessReply

回复process动作结果

参数

  • SystemId: S32 - 系统ID
  • FirmwareType: String - 固件的类型信息,由固件管理统一分配管理
  • ProcessResult: S32 - 处理结果
  • AdditionalOptions: Object - 固件升级扩展可选参数字典,用于并行升级等扩展场景

FinishReply

回复finish动作结果

参数

  • SystemId: S32 - 系统ID
  • FirmwareType: String - 固件的类型信息,由固件管理统一分配管理
  • FinishResult: S32 - 完成结果
  • AdditionalOptions: Object - 固件升级扩展可选参数字典,用于并行升级等扩展场景

UpdateUpgradeStatus

固件子模块上报升级状态

参数

  • SystemId: S32 - 系统ID
  • FirmwareType: String - 固件的类型信息,由固件管理统一分配管理
  • ResultCode: S32 - int32 结果码,取值:0-OK,-1代表失败,其他值统一规划
  • Progress: S32 - 升级进度,为0到100的值
  • ResultDetail: String - 结果详细表述,对结果码进行更详细的解释
  • AdditionalOptions: Object - 固件升级扩展可选参数字典,用于并行升级等扩展场景

GetUpgradeStatus

获取升级状态

参数

  • TaskId: U32 - 任务标识

返回值

  • FirmwareType: String - 固件的类型信息,由固件管理统一分配管理
  • ResultCode: S32 - 成功为0,失败为-1
  • Progress: S32 - 进度0-100
  • ResultDetail: String - 结果详细表述,对结果码进行更详细的解释

GetUpdateProgress

获取所有升级任务的进度信息

返回值

  • UpgradeMode: String - 当前升级模式
  • UpgradeTasks: Array - 升级任务的进度信息

GetPendingFirmwareList

获取所有所有待生效固件信息

返回值

  • PendingFirmwareList: Array - 待生效固件信息

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

ParallelUpgradePackages: 结构体类型

  • FilePath: String - 升级包路径
  • AdditionalOptions: Object - 固件升级可选参数,用于升级需要的参数扩展

UpdateProgress: 结构体类型

  • TaskName: String - 升级任务名
  • Firmware: String - 升级固件描述
  • FirmwareInstance: String - 升级固件实例
  • FileName: String - 升级包名称
  • Percentage: String - 升级进度
  • TaskState: String - 升级状态
  • ErrorCode: S32 - 升级任务错误码

PendingFirmware: 结构体类型

  • SystemId: U8 - 系统ID
  • Firmware: String - 待生效固件描述
  • FirmwareInstance: String - 待生效固件实例
  • ActiveStatus: String - 生效状态,当前可有的取值有:'ToBeActivated', 'Activating', 'Activated'
  • ActiveAction: 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 - 生效任务标识

StartActiveWithPolicy

根据策略启动固件生效

参数

  • SystemId: S32 - 系统ID
  • AdditionalOptions: Object - 固件生效可选参数字典,用于传递生效策略

返回值

  • 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

Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.UpdateService.FirmwareActiveInfo

==属性==

属性名类型可读写信号通知描述
FirmwareIdString只读变更广播SystemId+固件类型(FirmwareType)
FirmwareTypeString只读变更广播固件类型
ActiveConditionString只读变更广播生效条件
ActiveModeString只读变更广播生效模式
ActiveStatusString读写变更广播生效状态
SystemIdString只读变更广播系统host id

bmc.kepler.UpdateService.FirmwareInfo

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播固件名称,同类型固件名称相同
NameString只读变更广播相同固件名称的固件可能有多个,在Description中区分
VersionString读写变更广播固件版本号
BuildNumString只读变更广播固件构建版本
ReleaseDateString读写变更广播固件发布时间
LowestSupportedVersionString只读变更广播固件支持的最低版本,可用于防回退
SoftwareIdString只读变更广播软件识别标签
ManufacturerString只读变更广播固件发布厂商名
UpdateableBoolean只读变更广播固件是否支持更新
LocationString只读变更广播固件加载的位置
RollbackStatusString读写变更广播回滚状态
ActiveModeString读写变更广播生效方式
ParametersObject读写变更广播升级任务的附加参数
StateString读写变更广播当前固件的使能状态
SeverityString读写变更广播固件或硬件的健康状态
MaxPackageSizeMiBS32只读变更广播固件升级所需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 - 固件名称,同类型固件名称相同

GetAllFirmwareInfo

获取所有固件信息

返回值

  • FirmwareInfoList: Array

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

FirmwareInfoItem: 结构体类型

  • FirmwareId: String - 固件标识
  • FirmwareInfo: Object - 固件信息

bmc.kepler.UpdateService.FirmwareMatchRules

==方法==


AddMatchRules

机型校验需要获取系统的ProductId、BoardId、Uid

参数

  • Rules: Array - product_mgmt调用此方法给firmware_mgmt发送属性值

==自定义类型==


KeyValueTable: 结构体类型

  • Key: String
  • Value: String

bmc.kepler.UpdateService.FirmwareRestore

==方法==


InitiateRestoreAction

用于注册固件修复任务

参数

  • ComponentID: U8 - 固件ID
  • ComponentIDEx: U32 - 固件扩展ID
  • AdditionalOptions: Object - 其他扩展选项

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.UpdateService.Maintenance

==方法==


Import

导入固件

参数

  • ComponentIdentifier: String - 待导入固件的组件标识
  • FilePath: String - 固件路径

返回值

  • TaskId: U32 - 异步任务ID

bmc.kepler.UpdateService.ManagerVersion

==属性==

属性名类型可读写信号通知描述
PlatformMajorVersionString只读变更广播BMC的平台软件主版本号,只读属性,不会随着定制版本发生变化,V3版本统一默认为5
MajorVersionString只读变更广播主要版本
MinorVersionString只读变更广播次要版本
VersionString只读变更广播组件版本

==方法==


GetReleaseVersion

获取原始版本号

返回值

  • ActiveReleaseVersion: String - 主分区版本号
  • BackupReleaseVersion: String - 备份分区版本号
  • AvailableReleaseVersion: String - 可用分区版本号

bmc.kepler.UpdateService.UpdateMgmt

==属性==

属性名类型可读写信号通知描述
DowngradeAllowedBoolean读写变更广播降级允许使能开关
RestoreFactorySettingsOptionU8读写变更广播升级BMC固件前配置清除配置项信息的选项,1:只保留固件BOOT区,2:只保留固件配置区,3:保留固件BOOT区和配置区,4:不保留固件的BOOT区和配置区,0:默认值,保持BMC原升级策略
RevokedVersionsString[]只读变更广播自定义吊销版本号集合,最大规格100个
RevokedVersionEnabledBoolean读写变更广播自定义吊销版本号功能开关,默认为false
ActiveImageU8只读变更广播标识当前处于active状态的镜像;0x01:Image1,0x02:Image2
LastActionU8只读变更广播记录上一次触发BMC重启的动作;0x00:NoAction,0x01:Upgrade,0x02:Rollback
LastUpgradeResultU8只读变更广播标识上一次升级是否升级并重启成功;0x00:未执行升级,0x01:升级成功,0x02:升级失败

==方法==


AddRevokedVersions

增加需要吊销的版本号

参数

  • Versions: String[] - 需要增加的吊销的版本列表,版本号单个版本长度限制为32,仅允许字符串、下划线、分隔符‘.’

RemoveRevokedVersions

删除需要吊销的版本号

参数

  • Versions: String[] - 需要删除的吊销的版本列表,版本号单个版本长度限制为32,仅允许字符串、下划线、分隔符‘.’

ClearRevokedVersions

清空所有的吊销的版本


==自定义类型==


Object: 结构体类型

  • key: String
  • value: Boolean

bmc.kepler.Watchdog2.Status

==属性==

属性名类型可读写信号通知描述
DoNotLogU8只读变更广播是否记录日志
TimerUseU8只读变更广播看门狗用途
TimerUseStrString只读变更广播看门狗用途字符串描述
SystemStartupStateU8读写变更广播Bios启动状态,由bios组件设置
RunningU8只读变更广播是否运行
PreTimeoutInterruptFlagU8只读变更广播是否预超时
PreTimeoutInterruptTypeU8只读变更广播预超时中断类型
PreTimeoutInterruptEnabledBoolean只读变更广播预超时使能
PreTimeoutInterruptIntervalU8只读变更广播预超时时间
TimeoutActionU8只读变更广播超时动作
OEMExpirationFlagU8只读变更广播OEM阶段超时标志
SMSExpirationFlagU8只读变更广播SMS阶段超时标志
OSLoadExpirationFlagU8只读变更广播OSLoad超时标志
BIOSPOSTExpirationFlagU8只读变更广播BIOS POST阶段超时标志
BIOSFRB2ExpirationFlagU8只读变更广播BIOS FRB2超时标志
InitialCountdownU16只读变更广播初始化计时时间
PresentCountdownU16只读变更广播当前倒计时时间
BIOSFailToStartFlagU8只读变更广播BIOS 启动失败标志
ExpirationEventDataU32只读变更广播看门狗超时状态,用于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:设置失败