bmc.kepler.AccountService ​

==属性==

==方法==

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 ​

==属性==

bmc.kepler.AccountService.Authentication ​

==属性==

==方法==

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 ​

==属性==

==方法==

ManageInterChassisWhitelist

用于管理框内BMC间通信请求源地址的白名单,仅在白名单中的地址,才允许创建会话。当InterChassisValidation属性值为'Static'时,基于本方法设置的白名单实时生效;当InterChassisValidation属性不是'Static'时,通过本方法设置的白名单不会生效。单个类型的白名单最多支持10条

参数

• Operation: String - 对白名单的操作行为
• Type: String - 待操作的白名单类型
• Item: String - 待操作的白名单对象。当Operation为'Add'时,不可为空字符串或'';当Operation为'Remove'时,不可为空,此时若传入'',代表清空本类白名单;当Operation为'Get'时,本参数被忽略

返回值

• List: String[] - 当前白名单类型的白名单列表全集

bmc.kepler.AccountService.Kerberos ​

==属性==

==方法==

ImportKeyTable

导入Keytab秘钥

参数

• Path: String

bmc.kepler.AccountService.LDAP ​

==属性==

bmc.kepler.AccountService.LDAP.LDAPController ​

==属性==

==方法==

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 ​

==属性==

==方法==

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 - 处理结果

VerifyPassword

参数

• Password: String - 需要验证的密码字符串

==自定义类型==

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.IpmiChannelConfig ​

==属性==

bmc.kepler.AccountService.ManagerAccount.SnmpUser ​

==属性==

==方法==

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 ​

==属性==

bmc.kepler.AccountService.RemoteGroup ​

==属性==

==方法==

Delete

删除远程认证组

bmc.kepler.AccountService.RemoteGroups ​

==属性==

==方法==

New

新增远程认证组

参数

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

返回值

• GroupId: String

bmc.kepler.AccountService.RestrictedPrivileges ​

==属性==

==自定义类型==

PrivilegeType: 枚举类型

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

bmc.kepler.AccountService.Role ​

==属性==

==方法==

SetRolePrivilege

设置角色权限

参数

• PrivilegeType: U8
• PrivilegeValue: Boolean

Delete

删除角色

bmc.kepler.AccountService.Roles ​

==属性==

==方法==

New

新增角色

参数

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

bmc.kepler.AccountService.Rule ​

==属性==

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 ​

==属性==

==方法==

GetChangedEvents

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

返回值

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

ConfirmChangedEvents

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

bmc.kepler.CertificateService ​

==属性==

==方法==

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

ImportCertificate

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

参数

• CertificateUsageType: Enum
• Type: String - 文件导入类型，可以是text或URI。text表示文本内容导入，Content字段为证书内容，URI表示文件导入，可以是本地或者远程文件
• Content: String - 证书文本内容或者文件路径，和Type配合，指定文件
• Id: U32 - 如果指定id则导入到对应的证书id下，如果id为0，则寻找一个可用id进行导入
• WithEncryptedKey: Boolean - 是否携带加密私钥
• Password: String - 证书文件密码，可以为空，当WithEncryptedKey为true时，才需要同步设置
• Extra: Extra

返回值

• Id: U32
• TaskId: U32 - 仅远程上传涉及，任务id
• Extra: Extra

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

BackupCertificate

证书备份

参数

• Usage: String - 备份用途,取值范围：'DataReset'、'DataRecover',当前仅支持深度还原(DataReset)场景下备份证书
• Certificates: String[] - 需要备份的证书，取值范围：'SSL'、'AlternativeSSL'、'GmSSL'

==自定义类型==

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
• 4: ManagerFirmwareCertificate
• 5: TrustedComponentCertificate
• 6: InterChassisAuthCertificate

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参数的值

Extra: 结构体类型

• key: String - 扩展字段key
• value: String - 扩展字段value

bmc.kepler.CertificateService.CA ​

==属性==

bmc.kepler.CertificateService.Certificate ​

==属性==

==方法==

DeleteCRL

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

GetCertificateString

获取当前证书的公钥文本信息

返回值

• CertificateString: String - 证书公钥文本信息

==自定义类型==

CertificateUsageType: 枚举类型

• 0: ManagerCACertificate
• 1: ManagerSSLCertificate
• 2: ManagerAccountCertificate
• 3: ManagerCMPCertificate
• 4: ManagerFirmwareCertificate
• 5: TrustedComponentCertificate
• 6: InterChassisAuthCertificate

bmc.kepler.CertificateService.Certificate.Account ​

==属性==

bmc.kepler.CertificateService.Certificate.CA ​

==属性==

==方法==

DeleteCRL

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

ImportCRL

参数

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

bmc.kepler.CertificateService.Certificate.Entity ​

==属性==

bmc.kepler.CertificateService.CertificateLocation ​

==属性==

bmc.kepler.CertificateService.Renew ​

==属性==

==方法==

Renew

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

bmc.kepler.CertificateService.Renew.Subject ​

==属性==

bmc.kepler.Dashboard.Observability ​

==属性==

bmc.kepler.Dashboard.Observability.Logs ​

==属性==

bmc.kepler.Dashboard.Observability.Metrics ​

==属性==

bmc.kepler.Dashboard.Observability.Traces ​

==属性==

bmc.kepler.EventService ​

==属性==

==方法==

SubmitTestEvent

模拟测试事件方法

参数

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

Rearm

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

bmc.kepler.EventService.Event ​

==属性==

==方法==

Rearm

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

参数

• SubscriptionType: String[] - 上报的网管类型: All、RedfishEvent、Syslog、SNMPTrap、Smtp

bmc.kepler.EventService.EventSync ​

==属性==

==方法==

SyncEvent

远程事件/告警同步接口

参数

• Location: LocationInfo - 按上报类型区分的事件位置信息,每个元素是一组键值对
• Events: String - 包含同步事件信息的json格式字符串

==自定义类型==

LocationInfo: 结构体类型

• key: String - 事件上报类型,取值包括:SMTP(邮件方式上报)、SNMPTrap(SNMP Trap方式上报)、Syslog(Syslog方式上报)、RedfishEvent(Redfish Event方式上报)
• value: String - 事件位置信息,支持通过CSR定制不同事件上报类型的位置信息内容

bmc.kepler.EventService.Subscriptions ​

==方法==

CreateDestination

创建订阅方法

参数

• DestinationValues: DestinationValues - 事件订阅的请求参数,分别包括Destination(事件订阅接收地址)、EventTypes(事件订阅侦听的事件类型)、HttpHeaders(事件订阅 HTTP 头参数)、Context(事件订阅上下文信息)、Protocol(事件订阅使用的协议)、MessageIds(事件订阅消息 Id 匹配列表)、OriginResources(事件订阅事件源匹配列表)、SendHeartbeat(告警心跳使能)、HeartbeatIntervalMinutes(告警心跳周期)、MetricReportDefinitions(指定事件订阅上报的 Metric Report 列表)、DeliveryRetryPolicy(事件上报重试策略)、Severities(告警发送级别)

返回值

• Id: U8 - 事件订阅资源的标识

==自定义类型==

DestinationValues: 结构体类型

• key: String
• value: String

bmc.kepler.EventService.Subscriptions.Destination ​

==属性==

==方法==

SetHttpHeaders

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

参数

• Headers: String - http请求头

Delete

删除事件订阅资源

ResumeSubscription

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

参数

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

返回值

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

SuspendSubscription

暂停redfish事件消息发送

bmc.kepler.EventService.Subscriptions.Redfish ​

==属性==

bmc.kepler.EventService.Subscriptions.Smtp ​

==属性==

==方法==

SetAddress

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

参数

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

bmc.kepler.EventService.Subscriptions.Smtp.Email ​

==属性==

==方法==

SetAnonymousState

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

参数

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

bmc.kepler.EventService.Subscriptions.Smtp.Receiver ​

==属性==

==方法==

SubmitTestEvent

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

bmc.kepler.EventService.Subscriptions.Smtp.Sender ​

==属性==

==方法==

SetUsername

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

参数

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

SetPassword

设置发件人用户密码

参数

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

bmc.kepler.EventService.Subscriptions.Snmp ​

==属性==

==方法==

SetCommunity

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

参数

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

GetCommunity

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

返回值

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

bmc.kepler.EventService.Subscriptions.Snmp.Nms ​

==属性==

==方法==

SubmitTestEvent

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

bmc.kepler.EventService.Subscriptions.SnmpDestination ​

==属性==

==方法==

Delete

删除时间订阅资源

SetAuthenticationKey

设置Snmp事件订阅鉴权密码/密钥

参数

• AuthenticationKey: String - 待设置的鉴权密码/密钥

SetEncryptionKey

设置Snmp事件订阅加密密码/密钥

参数

• EncryptionKey: String - 待设置的加密密码/密钥

SetCommunity

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

参数

• Key: String - 待设置的团体名

bmc.kepler.EventService.Subscriptions.SnmpDestinations ​

==方法==

CreateDestination

创建订阅方法

参数

• DestinationValues: DestinationValues - 事件订阅的请求参数,其中必选参数包括Destination(事件订阅接收地址)、EventFormatTypes(事件订阅侦听的事件类型)、Context(事件订阅上下文信息)、SubscriptionType(事件订阅类型);可选参数包括Severities(告警发送级别)、AuthenticationProtocol(snmp鉴权算法)、TrapMode(snmp trap模式)、ServerIdentity(主机标识);SNMPv1/SNMPv2c可选参数:TrapCommunity(团体名);SNMPv3可选参数:EncryptionProtocol(snmp加密算法)、AuthenticationKey(snmp鉴权密码)、EncryPtionKey(snmp加密密码)

返回值

• Id: U8 - 事件订阅资源的标识

==自定义类型==

DestinationValues: 结构体类型

• key: String
• value: String

bmc.kepler.EventService.Subscriptions.Syslog ​

==属性==

bmc.kepler.IpmiService.ChannelNumberMapping ​

==属性==

bmc.kepler.IpmiService.Firewall ​

==属性==

==方法==

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命令数组

AddWhiteList

增加 IPMI Firewall 白名单,当前仅支持标准IPMI命令

参数

• RequestWhiteList: Array

RemoveWhiteList

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

参数

• RequestWhiteList: Array

GetWhiteList

获取黑白名单列表

参数

• Channel: U8 - IPMI命令的通道编号
• LUN: U8 - IPMI命令的LUN编号

返回值

• ResponseWhiteList: Array

==自定义类型==

BWItem: 结构体类型

• NetFn: U8 - IPMI命令的网络码
• Cmd: U8 - IPMI命令的命令字
• Channel: U8 - IPMI命令的通道编号
• DataLength: U8 - IPMI命令的数据长度
• Datas: U8[] - IPMI命令的数据

WhiteItemRequest: 结构体类型

• NetFn: U8 - IPMI命令的网络码
• Cmd: U8 - IPMI命令的命令字
• SubFunctionList: U8[] - IPMI命令的通道编号
• Channel: U8 - IPMI命令的数据长度
• LUN: U8 - IPMI命令的数据

WhiteItemResponse: 结构体类型

• NetFn: U8 - IPMI命令的网络码
• Cmd: U8 - IPMI命令的命令字
• SubFunctionList: U8[] - IPMI命令的通道编号

bmc.kepler.IpmiService.MasterWriteRead ​

==属性==

bmc.kepler.JobService ​

==属性==

==方法==

GetJobTypes

获取已支持的Job任务信息

返回值

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

bmc.kepler.JobService.Job ​

==属性==

==方法==

DeleteJob

删除Job

UpdateJob

更新Job

参数

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

==自定义类型==

JobObject: 结构体类型

• key: String
• value: String

bmc.kepler.JobService.JobFunction ​

==属性==

==方法==

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 ​

==属性==

==方法==

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 ​

==属性==

bmc.kepler.KeyService.Keys ​

==方法==

RegisterKey

组件注册kmc服务，获取domainiD

参数

• AppName: String - 初始化的组件名称
• KsfName: String - 组件ksf文件主密钥文件名
• KsfBakName: String - 组件ksf文件备密钥文件名
• KsfPath: String - 组件主ksf文件路径
• KsfBakPath: String - 组件备ksf文件路径
• OwnerId: U32 - 密钥文件owner，所有者
• GroupId: U32 - 密钥文件所属的用户组

返回值

• DomainId: U32 - KMC域Id

bmc.kepler.LicenseService ​

==属性==

==方法==

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 ​

==属性==

bmc.kepler.LicenseService.License ​

==属性==

==方法==

GetContent

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

返回值

• Content: String - License信息

bmc.kepler.Manufacture ​

==属性==

==方法==

Start

开始装备测试项

Stop

停止装备测试项

GetResult

获取装备测试项结果

返回值

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

bmc.kepler.Manufacture.Extension ​

==属性==

bmc.kepler.Manufacture.Simulate ​

==属性==

bmc.kepler.Manufacture.Status ​

==属性==

bmc.kepler.ObservabilityService ​

==属性==

bmc.kepler.ObservabilityService.Logs ​

==方法==

GetConfigurations

获取日志收集策略配置

返回值

• Configurations: ConfigData

SetConfigurations

设置日志收集策略配置，支持参数：(1) Enabled 日志采集使能开关，取值范围：true、false；(2) ExportIntervalSeconds 日志采集和上报周期，单位为秒，取值范围：[2, 60]

参数

• Configurations: ConfigData

==自定义类型==

ConfigData: 结构体类型

• key: String
• value: String

bmc.kepler.ObservabilityService.Metrics ​

==属性==

==方法==

GetConfigurations

获取度量指标策略配置

返回值

• Configurations: ConfigData

SetConfigurations

设置度量指标策略配置，支持参数：(1) ExportIntervalSeconds 度量指标采集周期，单位为秒，取值范围：[5, 3600]；(2) ActivatedMetrics 各度量指标使能开关，根据SupportedMetrics显示支持的度量名称进行设置

参数

• Configurations: ConfigData

==自定义类型==

ConfigData: 结构体类型

• key: String
• value: String

bmc.kepler.ObservabilityService.Receiver ​

==属性==

==方法==

SubmitTestTelemetryData

发送可观测功能测试数据

bmc.kepler.ObservabilityService.Traces ​

==属性==

==方法==

GetConfigurations

获取跟踪策略配置

返回值

• Configurations: ConfigData

SetConfigurations

设置跟踪策略配置，支持参数：(1) SamplingRate 跟踪采样率，数值精确到小数点后六位，取值范围：[0.000000 - 1.000000]；(2) SamplingPolicy 跟踪采样策略，取值范围：Fixed:固定采样、Adaptive:自适应采样；(3) SamplingLevel 跟踪分级策略，取值范围：System 系统级采样、Component 组件级采样、Function 功能级采样 (4) ExportIntervalSeconds 跟踪数据上报周期，单位为秒，取值范围：[2, 60]

参数

• Configurations: ConfigData

==自定义类型==

ConfigData: 结构体类型

• key: String
• value: String

bmc.kepler.Release.Chip ​

==方法==

Read

从器件的指定偏移位置读取指定长度的数据

参数

• Offset: U32 - 数据读取的起始位置偏移量（以字节为单位）
• Length: U32 - 要读取的数据长度（以字节为单位）

返回值

• OutData: U8[] - 从器件指定位置读取的原始数据（字节数组）

bmc.kepler.Release.Maintenance ​

==方法==

Dloglimit

设置组件日志限流状态

参数

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

bmc.kepler.Release.Managers.SOC.Coprocessor ​

==方法==

SetLogLevel

参数

• LogLevel: U8

bmc.kepler.Release.Mctp ​

==方法==

TraceMessage

跟踪指定MCTP端点的报文传输

参数

• Action: String - 跟踪操作类型：start表示开始跟踪MCTP端点报文，stop表示停止跟踪MCTP端点报文

bmc.kepler.Release.Mctp.Routing ​

==方法==

GetRouteTable

获取MCTP路由表信息

返回值

• Result: Array - MCTP路由表信息

==自定义类型==

DataItem: 结构体类型

• key: String - 路由表字段，包括PHYADDR，EID，PHYSICAL_MEDIA_IDENTIFIER等
• value: String - 路由表字段的值

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 - 电源风扇转速，单位：转/分钟（r/min）

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.Scanner ​

==方法==

TraceDebounce

跟踪指定扫描器的防抖处理过程，包括输入数据、计算逻辑和输出结果

参数

• Action: String - 跟踪操作类型：start表示开始跟踪防抖过程，stop表示停止跟踪防抖过程

bmc.kepler.Release.Storage.Controller ​

==方法==

GetControllerInfo

打印运行时RAID卡的数据

参数

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

返回值

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

==自定义类型==

Details: 结构体类型

• key: String
• value: String

bmc.kepler.Release.Storage.Drive ​

==方法==

GetDriveDetails

打印运行时硬盘数据

参数

• DriveName: String - 表示硬盘的名称，*代表所有硬盘

返回值

• DriveInfos: Array - 硬盘相关信息

==自定义类型==

DriveItem: 结构体类型

• DriveInfo: Details - 单个硬盘的相关信息

Details: 结构体类型

• key: String
• value: String

bmc.kepler.Release.Systems.SmcFirmwareStatus ​

==方法==

GetFirmwareObjectDetails

用于获取固件信息和升级状态

参数

• FirmwareType: String - 表示对象固件类型，取值范围：“MCU”,“VRD”

返回值

• FirmwareObjectDetails: Array - 获取固件信息和升级状态

==自定义类型==

FirmwareObjectDetails: 结构体类型

• 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.RoT.ComponentIntegrity ​

==属性==

bmc.kepler.RoT.ComponentIntegrity.MeasurementSet ​

==属性==

==方法==

SPDMGetSignedMeasurements

参数

• MeasurementIndices: U8[] - 一组用于表示度量块的索引值,数组包含[1~254]中的一个或多个唯一值,或者[255]
• SlotId: U8 - 对度量数据进行签名使用的证书私钥槽位索引,取值范围说明:0~7:代表指定特定槽位的证书;15:代表使用预先配置的公私钥对进行签名,仅当请求段已预先配置了响应端的公钥时才可使用
• Nonce: String - 挑战随机数,一个总长度为64的16进制字符串.规则:^[0-9a-fA-F][64]$

返回值

• Version: String - SPDM协商的版本号
• PublicKey: String - 可用于验证签名的公钥,仅当请求参数中SlotId为15时,本参数有效
• HashingAlgorithm: String - SPDM协商的哈希算法
• SigningAlgorithm: String - SPDM协商的签名算法
• SignedMeasurements: String - 基于Nonce和指定度量块计算得到的签名摘要的Base64字符串

bmc.kepler.RoT.ComponentIntegrity.SPDMMeasurement ​

==属性==

bmc.kepler.RoT.TrustedComponent ​

==属性==

bmc.kepler.SessionService ​

==属性==

bmc.kepler.SessionService.Session ​

==属性==

==方法==

SessionDelete

删除会话

参数

• LogoutType: U8 - 会话退出类型

bmc.kepler.SessionService.Sessions ​

==属性==

==方法==

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 - KVM会话模式，0：共享模式，1：独占模式

返回值

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

SetKvmKey

设置KVM直连凭证

参数

• SecretKey: String
• SessionMode: U8 - KVM会话模式，0：共享模式，1：独占模式

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.TaskService.Task ​

==属性==

bmc.kepler.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 ​

==属性==

==方法==

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 ​

==属性==

==方法==

DeleteTriggers

删除Triggers信息

bmc.kepler.TelemetryService.TriggersCollection ​

==方法==

NewTriggers

创建Triggers

参数

• Triggers: String - 创建Triggers的入参json字符串

ResetToDefaults

恢复所有Triggers到预设状态

bmc.kepler.UpdateService ​

==属性==

==方法==

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 - 解压后的固件升级文件的位置

ActiveStagedFirmwares

用于暂存生效

参数

• FirmwareIds: String[] - 待暂存生效固件ID列表

返回值

• TaskId: U32 - 暂存生效的主任务ID
• SubTaskIds: U32[] - 暂存生效的子升级任务ID列表

DiscardStagedFirmwares

弃用待暂存生效固件

参数

• FirmwareIds: String[] - 待弃用的暂存生效固件ID列表

返回值

• TaskId: U32 - 弃用暂存生效的主任务ID
• SubTaskIds: U32[] - 弃用暂存生效的子升级任务ID列表

FullImageUnpack

对整包进行解析和校验

参数

• FilePath: String - 需要解压的整包路径

返回值

• TaskId: U32 - 整包升级解析任务ID

==自定义类型==

Object: 结构体类型

• key: String
• value: String

ParallelUpgradePackages: 结构体类型

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

UpdateProgress: 结构体类型

• key: String
• value: String

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

GetCRLStrings

查询导入的CRL，返回升级所用吊销列表

返回值

• CRLString: Array - 字符串数组，每个字符串表示一个具体吊销列表文本信息

==自定义类型==

CRLStringsItems: 结构体类型

• CRL: String

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 - 处理结果

DeleteActiveAction

删除待生效对象

参数

• FirmwareIds: String[] - 待生效固件ID列表

==自定义类型==

KeyValueTable: 结构体类型

• Key: String
• Value: String

Object: 结构体类型

• key: String
• value: String

bmc.kepler.UpdateService.FirmwareActiveInfo ​

==属性==

bmc.kepler.UpdateService.FirmwareInfo ​

==属性==