ResourceDefinition

uris

/redfish/v1/Managers/manager_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	指定管理资源模型的OData描述信息
@odata.id	string	true	-	指定管理资源节点的访问路径
@odata.type	string	true	-	指定管理资源类型
GraphicalConsole {	object	false	-	图形控制台配置信息
GraphicalConsole.ConnectTypesSupported[ ]	array	true	-	支持的连接类型
GraphicalConsole.MaxConcurrentSessions	number	true	-	最大并发会话数
GraphicalConsole.ServiceEnabled	boolean	false	-	图形控制台服务是否使能
}
Id	string	false	-	指定管理资源的ID
Name	string	false	-	指定管理资源的名称
ManagerType	string	true	-	指定管理资源的详细类型包括： ● BMC
FirmwareVersion	string	true	-	指定管理资源的FW版本号
UUID	string	false	-	指定管理资源的全局唯一标识符
Model	string	true	-	指定管理资源的型号
DateTime	string	false	-	指定管理资源的系统时间说明已屏蔽该属性频繁变化导致的事件上报
Status {	object	true	-	指定管理资源的状态，包括： ● Health：管理资源健康状态 ● State：管理资源使能状态 ● Severity：管理资源的自定义健康状态
Status.Oem {	object	true	-	自定义属性
Status.Oem.Public {	object	false	-	自定义属性
Status.Oem.Public.Severity	string	true	-	严重性Redfish支持的严重级别包括：OK、Warning、Critical。
}
}
Status.Health	string	true	-	指定管理服务健康状态
Status.State	string	true	-	指定管理服务状态
}
Oem {	object	true	-	自定义属性
Oem.Public {	object	false	-	自定义属性
Oem.Public.EthernetInterfaces {	object	true	-	指定管理资源的网口信息的访问路径
Oem.Public.EthernetInterfaces.@odata.id	string	true	-	EthernetInterfaces资源节点的访问路径
}
Oem.Public.HostName	string	true	-	BMC主机名
Oem.Public.TimeZoneConfigurable	boolean	true	-	是否支持设置时区
Oem.Public.DefaultIPv4Info {	object	true	-	默认IPV4信息
Oem.Public.DefaultIPv4Info.IPMode	string	true	-	IPV4模式
Oem.Public.DefaultIPv4Info.IPv4Address	string	true	-	出厂默认IPV4地址
}
Oem.Public.DeviceIPv4	string	true	-	BMC的IPV4地址
Oem.Public.DeviceIPv6	string	true	-	BMC的IPV6地址
Oem.Public.DomainName	string	true	-	BMC主机域名
Oem.Public.BMCUpTime	string	true	-	BMC运行时间说明已屏蔽该属性频繁变化导致的事件上报
Oem.Public.ProductUniqueID	string	true	-	产品唯一识别ID
Oem.Public.PlatformType	string	true	-	平台识别
Oem.Public.SPStatus	string	true	-	SP状态包括： ● SPIsWorking ● SPIsOperable ● BIOSNeedsUpdate ● OSIsPoweredOff ● iBMCNeedsUpdate ● SPNeedsUpdate ● SPPartitionTableNotExist说明GA140C机型不支持
Oem.Public.ShelfPowerButtonMode	string	false	-	框电源按钮管理模式，包括： ● host ● bmc
Oem.Public.RemoteOEMInfo[ ]	array	false	-	第三方共享信息
Oem.Public.MaxServerCount	number	true	-	BMC管理的计算系统资源的最大数量
Oem.Public.SystemManagerInfo {	object	true	-	系统管理信息
Oem.Public.SystemManagerInfo.Id	string	false	-	指定管理资源的ID
Oem.Public.SystemManagerInfo.Name	string	false	-	指定管理资源的名称
Oem.Public.SystemManagerInfo.Ip	string	false	-	上层管理软件IP
Oem.Public.SystemManagerInfo.LockedTime	string	false	-	上层管理软件纳管锁定BMC的时间
}
Oem.Public.LoginRule [ {	array	true	-	登录规则信息
Oem.Public.LoginRule[].MemberId	string	true	-	登录规则的编号
Oem.Public.LoginRule[].RuleEnabled	boolean	false	-	登录规则的使能状态
Oem.Public.LoginRule[].StartTime	null	false	-	时间字符串格式：YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM
Oem.Public.LoginRule[].EndTime	null	false	-	时间字符串格式：YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM
Oem.Public.LoginRule[].IP	null	false	-	IP地址
Oem.Public.LoginRule[].Mac	null	false	-	MAC地址格式：xx:xx:xxxx:xx:xx:xx:xx:xx
} ]
Oem.Public.Retirement {	object	true	-	退网信息
Oem.Public.Retirement.Status	string	true	-	指定管理资源的状态，包括： ● Health：管理资源健康状态 ● State：管理资源使能状态 ● Severity：管理资源的自定义健康状态
Oem.Public.Retirement.Progress	number	true	-	报废处置任务整体百分比进度
Oem.Public.Retirement.Details [ {	array	true	-	报废处置子任务状态信息
Oem.Public.Retirement.Details[].Scope	string	true	-	报废数据的范畴
Oem.Public.Retirement.Details[].State	string	true	-	报废处置子任务状态
} ]
}
Oem.Public.SecurityService {	object	true	-	安全服务资源访问路径
Oem.Public.SecurityService.@odata.id	string	true	-	SecurityService资源节点的访问路径
}
Oem.Public.SnmpService {	object	true	-	SNMP资源访问路径说明GA140C机型不支持
Oem.Public.SnmpService.@odata.id	string	true	-	SnmpService资源节点的访问路径
}
Oem.Public.LldpService {	object	true	-	LLDP资源访问路径
Oem.Public.LldpService.@odata.id	string	true	-	LldpService资源节点的访问路径
}
Oem.Public.USBMgmtService {	object	true	-	USBMgmt资源访问路径
Oem.Public.USBMgmtService.@odata.id	string	true	-	USBMgmtService资源节点的访问路径
}
Oem.Public.WirelessService {	object	true	-	Wireless资源访问路径
Oem.Public.WirelessService.@odata.id	string	true	-	WirelessService资源节点的访问路径
}
Oem.Public.SmtpService {	object	true	-	SMTP资源访问路径
Oem.Public.SmtpService.@odata.id	string	true	-	SmtpService资源节点的访问路径
}
Oem.Public.SyslogService {	object	true	-	Syslog资源访问路径
Oem.Public.SyslogService.@odata.id	string	true	-	SyslogService资源节点的访问路径
}
Oem.Public.KvmService {	object	true	-	KVM资源访问路径说明GA140C机型不支持
Oem.Public.KvmService.@odata.id	string	true	-	KvmService资源节点的访问路径
}
Oem.Public.DiagnosticService {	object	true	-	诊断服务资源访问路径
Oem.Public.DiagnosticService.@odata.id	string	true	-	DiagnosticService资源节点的访问路径
}
Oem.Public.NtpService {	object	true	-	NTP配置资源访问路径
Oem.Public.NtpService.@odata.id	string	true	-	NtpService资源节点的访问路径
}
Oem.Public.VncService {	object	true	-	VNC资源访问路径说明GA140C机型不支持
Oem.Public.VncService.@odata.id	string	true	-	VncService资源节点的访问路径
}
Oem.Public.SPService {	object	true	-	SP资源访问路径说明GA140C机型不支持
Oem.Public.SPService.@odata.id	string	true	-	SPService资源节点的访问路径
}
Oem.Public.LicenseService {	object	true	-	License资源访问路径说明GA140C机型不支持
Oem.Public.LicenseService.@odata.id	string	true	-	LicenseService资源节点的访问路径
}
Oem.Public.FDMService {	object	true	-	FDMService资源访问路径
Oem.Public.FDMService.@odata.id	string	true	-	FDMService资源节点的访问路径
}
Oem.Public.FlashWriteProtectState	string	true	-	当前flash的状态。包括： ● ReadOnly ● ReadWrite
Oem.Public.FlashStatictis {	object	true	-	Flash统计信息
Oem.Public.FlashStatictis.RemainingLifeTime	string	true	-	Flash剩余寿命
Oem.Public.FlashStatictis.VenderName	string	true	-	厂商名称
Oem.Public.FlashStatictis.TotalDataWritten	string	true	-	从BMC启动后记录的总写入量
Oem.Public.FlashStatictis.TotalDataWrittenIn15Days	string	true	-	15天内总写入量
Oem.Public.FlashStatictis.ReservedBlocks	number	true	-	Flash的预留块总数
Oem.Public.FlashStatictis.RuntimeBadBlocks	number	true	-	运行过程中产生的坏块数量
}
Oem.Public.Platform	string	true	-	当前Platform的类型包括： ● Arm ● X86
Oem.Public.RevokedVersionEnabled	boolean	false	-	BMC版本吊销功能的使能状态
Oem.Public.RevokedVersions[ ]	array	false	-	BMC吊销版本号列表
}
}
DateTimeLocalOffset	string	false	-	指定管理资源的时区
LastResetTime	string	true	-	BMC上次复位的时间点
Manufacturer	string	true	-	BMC的制造厂商名称
LogServices {	object	true	-	日志服务资源访问路径
LogServices.@odata.id	string	true	-	LogServices资源节点的访问路径
}
NetworkProtocol {	object	true	-	指定管理资源支持的网络协议的访问路径
NetworkProtocol.@odata.id	string	true	-	NetworkProtocol资源节点的访问路径
}
EthernetInterfaces {	object	true	-	指定管理资源的网口信息的访问路径
EthernetInterfaces.@odata.id	string	true	-	EthernetInterfaces资源节点的访问路径
}
VirtualMedia {	object	true	-	虚拟媒体资源访问路径说明GA140C机型不支持
VirtualMedia.@odata.id	string	true	-	VirtualMedia资源节点的访问路径
}
Actions {	object	true	-	指定管理组密钥导入操作
Actions.#Manager.Reset {	object	true	-	重启服务器的BMC
Actions.#Manager.Reset.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.#Manager.Reset.target	string	true	-	操作路径
}
Actions.#Manager.ResetToDefaults {	object	true	-	恢复出厂设置
Actions.#Manager.ResetToDefaults.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.#Manager.ResetToDefaults.target	string	true	-	操作路径
}
Actions.Oem {	object	true	-	自定义属性
Actions.Oem.Public {	object	false	-	自定义属性
Actions.Oem.Public.#Manager.DeleteLanguage {	object	true	-	卸载语言
Actions.Oem.Public.#Manager.DeleteLanguage.target	string	true	-	操作路径
Actions.Oem.Public.#Manager.DeleteLanguage.@Redfish.ActionInfo	string	true	-	操作信息查询路径
}
Actions.Oem.Public.#Manager.RestoreFactory {	object	true	-	恢复出厂设置
Actions.Oem.Public.#Manager.RestoreFactory.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.RestoreFactory.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.RollBack {	object	true	-	BMC镜像切换
Actions.Oem.Public.#Manager.RollBack.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.RollBack.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.Dump {	object	true	-	一键收集
Actions.Oem.Public.#Manager.Dump.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.Dump.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.QuickDump {	object	true	-	快速收集
Actions.Oem.Public.#Manager.QuickDump.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.QuickDump.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.ExportConfiguration {	object	true	-	导出BIOS、BMC和RAID控制器配置
Actions.Oem.Public.#Manager.ExportConfiguration.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.ExportConfiguration.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.ImportConfiguration {	object	true	-	导入BIOS、BMC、RAID控制器配置
Actions.Oem.Public.#Manager.ImportConfiguration.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.ImportConfiguration.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.GeneralDownload {	object	true	-	下载BMC文件
Actions.Oem.Public.#Manager.GeneralDownload.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.GeneralDownload.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.EnterRecoveryMode {	object	true	-	进入最小系统
Actions.Oem.Public.#Manager.EnterRecoveryMode.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.EnterRecoveryMode.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.ImportRevokedVersion {	object	true	-	设置BMC版本吊销列表
Actions.Oem.Public.#Manager.ImportRevokedVersion.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.ImportRevokedVersion.target	string	true	-	操作路径
}
Actions.Oem.Public.#Manager.TestConnection {	object	true	-	测试文件服务器连通性
Actions.Oem.Public.#Manager.TestConnection.@Redfish.ActionInfo	string	true	-	操作信息查询路径
Actions.Oem.Public.#Manager.TestConnection.target	string	true	-	操作路径
}
}
}
}
Links {	object	true	-	指定管理资源相关链接信息
Links.ManagerForChassis[].@odata.id	string	true	-	成员资源节点的访问路径
Links.ManagerForServers[].@odata.id	string	true	-	成员资源节点的访问路径
Links.ManagerForServers[ ]	array	true	-	相关服务器管理资源的链接
Links.ManagerForChassis[ ]	array	true	-	相关机箱管理资源的链接
Links.ManagerInChassis {	object	true	-	机箱内管理器链接
Links.ManagerInChassis.@odata.id	string	true	-	ManagerInChassis资源节点的访问路径
}
}
PowerState	string	true	On、Off	BMC上电状态
SerialConsole {	object	true	-	串口控制台配置信息
SerialConsole.ConnectTypesSupported[ ]	array	true	-	支持的连接类型
SerialConsole.MaxConcurrentSessions	number	true	-	最大并发会话数
SerialConsole.ServiceEnabled	boolean	false	-	指定管理服务使能
}
ServiceIdentification	string	true	-	服务标识

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询指定管理资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1",
"@odata.type": "#Manager.v1_9_0.Manager",
"Id": "1",
"Name": "Manager",
"ManagerType": "BMC",
"FirmwareVersion": "2.70",
"UUID": "36E6957C-1DD2-11B2-87FD-0018E1C5D866",
"Model": "iBMC",
"DateTime": "2017-05-22T17:06:19+00:00",
"Status": {
"Health": "Ok",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Enabled"
},
"DateTimeLocalOffset": "GMT",
"LastResetTime": "2017-05-21T17:06:19+00:00",
"Manufacturer": "",
"GraphicalConsole": {
"ServiceEnabled": true,
"ConnectTypesSupported": [
"KVMIP"
],
"MaxConcurrentSessions": 2
},
"LogServices": {
"@odata.id": "/redfish/v1/Managers/1/LogServices"
},
"SerialConsole": {
"ServiceEnabled": true,
"ConnectTypesSupported": [
"IPMI"
],
"MaxConcurrentSessions": 1
},
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"
},
"VirtualMedia": {
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"
},
"Oem": {
"Public": {
"HostName": "BMC",
"TimeZoneConfigurable": true,
"DefaultIPv4Info": {
"IPMode": "Static",
"IPv4Address": "device_ip"
},
"DeviceIPv4": "device_ip",
"DeviceIPv6": "fd00::6516",
"DomainName": "",
"BMCUpTime": "0 days 00h:10m:53s",
"ProductUniqueID": "0x10200",
"PlatformType": "0x10",
"SPStatus": "SPIsWorking",
"ShelfPowerButtonMode": "host",
"MaxServerCount": 1,
"RemoteOEMInfo": [
1,
2
],
"SystemManagerInfo": {
"Id": "d6ef51d3-244f-4d09-a45a-6fae9b71f0d4",
"Name": "FusionDirector",
"Ip": "192.168.2.100",
"LockedTime": "2019-03-16 15:26:13"
},
"LoginRule": [
{
"MemberId": "Rule1",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
},
{
"MemberId": "Rule2",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
},
{
"MemberId": "Rule3",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
}
],
"Retirement": {
"Status": "Executing",
"Progress": 20,
"Details": [
{
"Scope": "BIOS",
"State": "Completed"
},
{
"Scope": "BMC",
"State": "Running"
}
]
},
"SecurityService": {
"@odata.id": "/redfish/v1/Managers/1/SecurityService"
},
"SnmpService": {
"@odata.id": "/redfish/v1/Managers/1/SnmpService"
},
"LldpService": {
"@odata.id": "/redfish/v1/Managers/1/LldpService"
},
"USBMgmtService": {
"@odata.id": "/redfish/v1/Managers/1/USBMgmtService"
},
"WirelessService": {
"@odata.id": "/redfish/v1/Managers/1/WirelessService"
},
"SmtpService": {
"@odata.id": "/redfish/v1/Managers/1/SmtpService"
},
"SyslogService": {
"@odata.id": "/redfish/v1/Managers/1/SyslogService"
},
"KvmService": {
"@odata.id": "/redfish/v1/Managers/1/KvmService"
},
"DiagnosticService": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService"
},
"NtpService": {
"@odata.id": "/redfish/v1/Managers/1/NtpService"
},
"VncService": {
"@odata.id": "/redfish/v1/Managers/1/VncService"
},
"SPService": {
"@odata.id": "/redfish/v1/Managers/1/SPService"
},
"FDMService": {
"@odata.id": "/redfish/v1/Managers/1/FDMService"
},
"LicenseService": {
"@odata.id": "/redfish/v1/Managers/1/LicenseService"
},
"FlashWriteProtectState": "flash_protect_mode",
"FlashStatictis": {
"VenderName": "hynix",
"RemainingLifeTime": "60%+",
"TotalDataWritten": "0.020GB",
"TotalDataWrittenIn15Days": "0.014GB",
"ReservedBlocks": 92,
"RuntimeBadBlocks": 0
},
"Platform": "platform",
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/NICs"
},
"RevokedVersionEnabled": false,
"RevokedVersions": [
"5.8.3.1",
"5.8.3.2"
]
}
},
"Actions": {
"#Manager.Reset": {
"target": "/redfish/v1/Managers/1/Actions/Manager.Reset",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ResetActionInfo"
},
"#Manager.ResetToDefaults": {
"target": "/redfish/v1/Managers/1/Actions/Manager.ResetToDefaults",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ResetToDefaultsActionInfo"
},
"Oem": {
"Public": {
"#Manager.DeleteLanguage": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.DeleteLanguage",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DeleteLanguageActionInfo"
},
"#Manager.RestoreFactory": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/RestoreFactoryActionInfo"
},
"#Manager.RollBack": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RollBack",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/RollBackActionInfo"
},
"#Manager.Dump": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DumpActionInfo"
},
"#Manager.QuickDump": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.QuickDump",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/QuickDumpActionInfo"
},
"#Manager.ExportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ExportConfigurationActionInfo"
},
"#Manager.ImportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ImportConfigurationActionInfo"
},
"#Manager.GeneralDownload": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/GeneralDownloadActionInfo"
},
"#Manager.EnterRecoveryMode": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.EnterRecoveryMode",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/EnterRecoveryModeActionInfo"
},
"#Manager.ImportRevokedVersion": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportRevokedVersion",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ImportRevokedVersionActionInfo"
},
"#Manager.TestConnection": {
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.TestConnection",
"@Redfish.ActionInfo":"/redfish/v1/Managers/1/TestConnectionActionInfo"
}
}
}
},
"Links": {
"ManagerForServers": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"ManagerForChassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"ManagerInChassis": {
"@odata.id": "/redfish/v1/Chassis/1"
}
},
"PowerState": "On",
"ServiceIdentification": "BMC"
}

响应码：200

PATCH

命令功能

修改指定管理资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
"UUID": uuid_value,
"DateTime": datetime_value,
"DateTimeLocalOffset": datetimelocaloffset_value,
"GraphicalConsole": {
"ServiceEnabled": serviceenabled_value
},
"Oem": {
"Public": {
"LanguageSet": language_set_value,
"RemoteOEMInfo": remote_value,
"DeviceLocation":device_value,
"Stateless": {
"SysManagerId": sysmanagerid_value,
"SysManagerIP": sysmanagerip_value,
"SysManagerPort": sysmanagerport_value,
"ControlPowerOnEnabled": control_value,
"ShelfPowerButtonMode": power_button_mode_value,
"AutoSearchEnabled": auto_value,
"VGAUSBDVDEnabled": vga_value
},
"SystemManagerInfo": {
"Id": system_manager_id_value,
"Name": system_manager_name_value,
"Ip": system_manager_ip_value,
"LockedTime": system_manager_locked_time_value
},
"LoginRule": [
{
"RuleEnabled": rule_enabled_value,
"StartTime": start_time_value,
"EndTime": end_time_value,
"IP": ip_value,
"Mac": mac_value
}
],
"RevokedVersionEnabled": revoke_value
}
}
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
UUID	管理资源的UUID	● 格式满足正则表达式： ^[0-9A-F]{8}-[0-9A-F] {4}-[0-9A-F] {4}-[0-9A-F] {4}-[0-9A-F]{12}$ ● 00000000-0000-0000- 0000-000000000000代表恢复UUID为默认值 ● 单板AC掉电后自动恢复为默认值
DateTime	管理资源的时间	● 系统时间格式：yyyy-mm- ddThh:mm:ss+hh:mm或yyyy-mm-ddThh:mm:ss- hh:mm时间取值范围：2000-01-01T00:00:00~20 99-12-31T23:59:59；时区取值范围：-12:00~ +12:00；示例：2019-01-05T14:01:30+10: 00说明 ● 时区设置只支持UTC时间 ● 如果系统存在同步时间源，以同步时间源为准
DateTimeLocalOffset	管理资源的时区	● 时间偏移格式：+hh:mm或-hh:mm取值范围：-12:00～ +14:00示例：+08:59；格式：UTC+hh:mm或UTC-hh:mm取值范围：UTC-12:00～ UTC+14:00示例：UTC+8:00；格式：GMT+hh:mm或GMT-hh:mm取值范围：GMT-12:00～ GMT+14:00示例：GMT+8:00； ● 时区名称示例：Asia/ Shanghai，America/ New_York说明 ● 默认值：“UTC” ● 当修改值不带时区标准名或是时区名称时，默认采用UTC时间
ServiceEnabled	图形控制台使能状态	● true ● false
LanguageSet	语言支持信息	● 字符串类型 ● 不支持关闭中英文语言，且设置的语言参数必须是当前版本所支持的说明 ● 除中英文语言外，ja，fr，ru支持开启或者关闭 ● en，zh，ja，fr，ru分别表示英语，汉语，日语，法语，俄语，中间用逗号隔开
RemoteOEMInfo	第三方共享信息	0~255
DeviceLocation	位置信息	字符串类型值
SysManagerId	管理服务器ID	字符串类型值
SysManagerIP	管理服务器IP	IPv4地址
SysManagerPort	管理服务器端口	1~65535
ControlPowerOnEnabled	是否允许受控上电	● true ● false说明E9000H为预留接口，暂不支持
ShelfPowerButtonMode	框电源按钮管理模式	● host ● bmc
AutoSearchEnabled	是否启用自动发现	● true ● false
VGAUSBDVDEnabled	是否启用VGA，USB，DVD	● true ● false
Id	上层管理软件的ID	● 字符串类型值
Name	上层管理软件的Name	● 字符串类型值
Ip	上层管理软件IP	● 字符串类型值
LockedTime	上层管理软件纳管锁定BMC的时间	● 字符串类型值
RuleEnabled	启用状态	● true ● false
StartTime	开始时间	时间字符串格式：YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM
EndTime	结束时间	时间字符串格式：YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM
IP	IP	ipv4格式：xxx.xxx.xxx.xxx和xxx.xxx.xxx.xxx/ mask；mask取值范围为1~32。ipv6格式：XXXX:XXXX:XXXX:XXXX:X XXX:XXXX:XXXX:XXXX和XXXX:XXXX:XXXX:XXXX:X XXX:XXXX:XXXX:XXXX/ mask；每组中的前导"0" 都可以省略，地址中包含的连续两个或多个均为0的组，可以用双冒号“::”来代替，mask取值范围为1~128。说明BMC300在5.8版本支持ipv6登录规则，若回退至历史版本，会导致设置的ipv6登录规则失效
Mac	MAC	MAC
RevokedVersionEnabled	版本吊销功能使能状态	● true ● false

使用指南

无

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id

X-Auth-Token: auth_value Content-Type: header_type If-Match: ifmatch_value 请求消息体：

json

{
"UUID": uuid_value,
"DateTime": datetime_value,
"DateTimeLocalOffset": datetimelocaloffset_value,
"GraphicalConsole": {
"ServiceEnabled": serviceenabled_value
},
"Oem": {
"Public": {
"LanguageSet": language_set_value,
"RemoteOEMInfo": remote_value,
"DeviceLocation":device_value,
"Stateless": {
"SysManagerId": sysmanagerid_value,
"SysManagerIP": sysmanagerip_value,
"SysManagerPort": sysmanagerport_value,
"ControlPowerOnEnabled": control_value,
"ShelfPowerButtonMode": power_button_mode_value,
"AutoSearchEnabled": auto_value,
"VGAUSBDVDEnabled": vga_value
},
"SystemManagerInfo": {
"Id": system_manager_id_value,
"Name": system_manager_name_value,
"Ip": system_manager_ip_value,
"LockedTime": system_manager_locked_time_value
},
"LoginRule": [
{
"RuleEnabled": rule_enabled_value,
"StartTime": start_time_value,
"EndTime": end_time_value,
"IP": ip_value,
"Mac": mac_value
}
],
"RevokedVersionEnabled": revoke_value
}
}
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1",
"@odata.type": "#Manager.v1_9_0.Manager",
"Id": "1",
"Name": "Manager",
"ManagerType": "BMC",
"FirmwareVersion": "2.50",
"UUID": "2BFF4014-1DD2-11B2-818C-0018E1C5D866",
"Model": "iBMC",
"DateTime": "2017-05-22T20:36:48+14:00",
"Status": {
"Health": "Ok",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Enabled"
},
"DateTimeLocalOffset": "GMT+14:00",
"LastResetTime": "2017-05-21T17:06:19+14:00",
"Manufacturer": "",
"GraphicalConsole": {
"ServiceEnabled": true,
"ConnectTypesSupported": [
"KVMIP"
],
"MaxConcurrentSessions": 2
},
"LogServices": {
"@odata.id": "/redfish/v1/Managers/1/LogServices"
},
"SerialConsole": {
"ServiceEnabled": true,
"ConnectTypesSupported": [
"IPMI"
],
"MaxConcurrentSessions": 1
},
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"
},
"VirtualMedia": {
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"
},
"Oem": {
"Public": {
"HostName": "BMC",
"TimeZoneConfigurable": true,
"DefaultIPv4Info": {
"IPMode": "Static",
"IPv4Address": "device_ip"
},
"DeviceIPv4": "device_ip",
"DeviceIPv6": "fd00::6516",
"DomainName": "",
"LanguageSet": "en,zh,fr",
"BMCUpTime": "0 days 00h:10m:53s",
"ProductUniqueID": "0x10f00",
"PlatformType": "0x10",
"SPStatus": "SPIsWorking",
"ShelfPowerButtonMode": "host",
"RemoteOEMInfo": [0],
"DeviceLocation": null,
"MaxServerCount": 1,
"Stateless": {
"SysManagerId": "ZQ",
"SysManagerIP": "10.10.10.1",
"SysManagerPort": 26957,
"ControlPowerOnEnabled": true,
"AutoSearchEnabled": false
},
"SystemManagerInfo": {
"Id": "d6ef51d3-244f-4d09-a45a-6fae9b71f0d4",
"Name": "FusionDirector",
"Ip": "192.168.2.100",
"LockedTime": "2019-03-16 15:26:13"
},
"LoginRule": [
{
"MemberId": "Rule1",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
},
{
"MemberId": "Rule2",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
},
{
"MemberId": "Rule3",
"RuleEnabled": false,
"StartTime": null,
"EndTime": null,
"IP": null,
"Mac": null
}
],
"SecurityService": {
"@odata.id": "/redfish/v1/Managers/1/SecurityService"
},
"SnmpService": {
"@odata.id": "/redfish/v1/Managers/1/SnmpService"
},
"LldpService": {
"@odata.id": "/redfish/v1/Managers/1/LldpService"
},
"USBMgmtService": {
"@odata.id": "/redfish/v1/Managers/1/USBMgmtService"
},
"WirelessService": {
"@odata.id": "/redfish/v1/Managers/1/WirelessService"
},
"SmtpService": {
"@odata.id": "/redfish/v1/Managers/1/SmtpService"
},
"SyslogService": {
"@odata.id": "/redfish/v1/Managers/1/SyslogService"
},
"KvmService": {
"@odata.id": "/redfish/v1/Managers/1/KvmService"
},
"DiagnosticService": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService"
},
"NtpService": {
"@odata.id": "/redfish/v1/Managers/1/NtpService"
},
"VncService": {
"@odata.id": "/redfish/v1/Managers/1/VncService"
},
"SPService": {
"@odata.id": "/redfish/v1/Managers/1/SPService"
},
"FDMService": {
"@odata.id": "/redfish/v1/Managers/1/FDMService"
},
"LicenseService": {
"@odata.id": "/redfish/v1/Managers/1/LicenseService"
},
"FusionPartition": "DualSystem",
"RemoteBMCIPv4Address": "device_ip",
"VGAUSBDVDEnabled": true,
"FlashWriteProtectState": "flash_protect_mode",
"Platform": "platform",
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/NICs"
},
"RevokedVersionEnabled": true,
"RevokedVersions": [
"5.8.3.1",
"5.8.3.2"
]
}
},
"Actions": {
"#Manager.Reset": {
"target": "/redfish/v1/Managers/1/Actions/Manager.Reset",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ResetActionInfo"
},
"Oem": {
"Public": {
"#Manager.DeleteLanguage": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.DeleteLanguage",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DeleteLanguageActionInfo"
},
"#Manager.RestoreFactory": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/RestoreFactoryActionInfo"
},
"#Manager.RollBack": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RollBack",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/RollBackActionInfo"
},
"#Manager.Dump": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DumpActionInfo"
},
"#Manager.ExportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ExportConfigurationActionInfo"
},
"#Manager.ImportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ImportConfigurationActionInfo"
},
"#Manager.PowerOnPermit": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.PowerOnPermit",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/PowerOnPermitActionInfo"
},
"#Manager.GeneralDownload": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/GeneralDownloadActionInfo"
},
"#Manager.EnterRecoveryMode": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.EnterRecoveryMode",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/EnterRecoveryModeActionInfo"
},
"#Manager.ImportRevokedVersion": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportRevokedVersion",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/ImportRevokedVersionActionInfo"
}
}
}
},
"Links": {
"ManagerForServers": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"ManagerForChassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"ManagerInChassis": {
"@odata.id": "/redfish/v1/Chassis/1"
}
},
"PowerState": "On",
"ServiceIdentification": "BMC"
}

响应码：200

POST (ACTION)

DeleteLanguage

命令功能

卸载语言

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.DeleteLanguage

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Language": language
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
Language	请求卸载的语言	字符串，必须是已安装的语言，中文和英文不支持卸载。

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.DeleteLanguage

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Language": language
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

RestoreFactory

命令功能

恢复出厂设置（自定义接口）

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RestoreFactory

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{}

请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RestoreFactory

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

Dump

命令功能

一键收集

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.Dump

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Type": type_value,
  "Content": content_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
type_value	一键收集的方法	● URI
content_value	一键收集文件的路径	操作路径 ● 本地导出："/tmp/文件名" ● 远程导出："文件传输协议://用户名:密码@ip地址/目录/文件名" 文件传输协议包括五种：sftp、https、nfs、cifs、scp

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.Dump

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Type": type_value,
  "Content": content_value
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Export Dump File Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-05-09T16:57:14+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION)

QuickDump

命令功能

快速收集（精简日志收集）

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.QuickDump

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Type": type_value,
  "Content": content_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
type_value	精简日志收集的方法	● URI
content_value	精简日志收集文件的路径	操作路径 ● 本地导出："/tmp/文件名" ● 远程导出："文件传输协议://用户名:密码@ip地址/目录/文件名" 文件传输协议包括五种：sftp、https、nfs、cifs、scp

使用指南

目前仅 A900 A3 Pod 、GA140C、A800T A3可用，日志收集范围根据机型精简，减少收集时间；其他机型不支持，调用时返回 400。

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.QuickDump

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Type": type_value,
  "Content": content_value
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Export Dump File Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "PercentComplete": null,
  "StartTime": "2017-05-09T16:57:14+00:00",
  "Messages": [],
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION)

ImportConfiguration

命令功能

导入 BIOS、BMC 和 RAID 控制器配置

说明

注：导入BIOS配置资源表示已下发BIOS setup项，但当前还未生效，下次系统重启时生效。下电状态导入RAID控制器配置，在下次系统重启时生效

说明

导入BIOS配置资源表示已下发BIOS setup项，但当前还未生效，下次系统重启时生效。下电状态导入RAID控制器配置，在下次系统重启时生效。

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Type": type_value,
  "Content": content_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
type_value	导入配置文件的方法	● URI
content_value	导入配置文件路径	操作路径 ● 本地导入："/tmp/文件名" ● 远程导入："文件传输协议://用户名:密码@ip地址/目录/文件名" 文件传输协议包括五种：sftp、https、nfs、cifs、scp ● 文件扩展名必须是 “.json”

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Type": type_value,
  "Content": content_value
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Import Config File Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-05-10T22:50:14+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION)

ExportConfiguration

命令功能

导出 BIOS、BMC 和 RAID 控制器配置

说明

注：RAID控制器配置需在操作系统重启完成之后导出才有效

说明

RAID控制器配置需在操作系统重启完成之后导出才有效。

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Type": type_value,
  "Content": content_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
type_value	导出配置文件方法	● URI
content_value	导出配置文件的路径	操作路径 ● 本地导出："/tmp/文件路径" ● 远程导出："文件传输协议://用户名:密码@ip地址/目录/文件名" 文件传输协议包括五种：sftp、https、nfs、cifs、scp ● 文件扩展名必须是 “.json”

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Type": type_value,
  "Content": content_value
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": " Export Config File Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-05-10T22:50:14+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION)

GeneralDownload

命令功能

下载 BMC 文件

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.GeneralDownload

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "TransferProtocol": value,
  "Path": path
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
value	协议类型	支持的协议包括： ● HTTPS
path	下载路径	BMC中文件所在路径：指"/ tmp"及其子目录。

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.GeneralDownload

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "TransferProtocol": value,
  "Path": path
}

响应码：200

POST (ACTION)

EnterRecoveryMode

命令功能

进入最小系统

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.EnterRecoveryMode

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{}

请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.EnterRecoveryMode

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ForceClearCMOS

命令功能

重启 BMC

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.Reset

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "ResetType": value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
value	重启操作	当前仅可选择 “ForceRestart”，即强制重启。

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.Reset

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "ResetType": value
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ForceRestart

命令功能

切换 BMC 镜像

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RollBack

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{}

请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RollBack

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

RetireSystem

命令功能

报废处置

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RetireSystem

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "PreserveLog": PreserveLog_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
PreserveLog_value	是否保存报警、维护和故障诊断日志	● true：保存报警、维护和故障诊断日志以供故障排除 ● false：清除所有日志文件

使用指南

BMC300 5.5.0.1及以上版本支持此功能。操作前需要保证OS下电。

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RetireSystem

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "PreserveLog": PreserveLog_value
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ImportRevokedVersion

命令功能

设置 BMC 吊销版本列表

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportRevokedVersion

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Operation": operation_value,
  "RevokedVersions": revoked_versions_value
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
operation_value	吊销版本号的设置方式	字符串，必须是"Add"、 "Delete"或"Clear" 说明 “Add”：添加版本号； “Delete”：删除版本号； “Clear”清空吊销版本列表；
revoked_versions_value	需要设置的版本号	字符串数组，BMC中能够存储的吊销版本号列表最大规格为100，版本号单个版本长度限制为32，仅允许字符串、下划线、分隔符‘.’ 说明添加版本号时，当执行添加后，吊销列表中版本号数量超过最大规格，则执行添加操作失败；删除版本号时，当参数RevokedVersions中有吊销版本列表中不存在的版本号时，能够执行成功，吊销版本列表中存在的版本号正常删除

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportRevokedVersion

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Operation": operation_value,
  "RevokedVersions": revoked_versions_value
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ResetToDefaults

命令功能

恢复出厂设置（自定义接口）

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.ResetToDefaults

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "ResetType": reset_type
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
reset_type	恢复出厂设置的类型	支持的类型包括： ● ResetAll：将所有配置还原 ● PreserveNetwork：保留网络配置 ● PreserveNetworkAndUs ers：保留网络配置和用户配置（用户名、密码信息）

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.ResetToDefaults

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "ResetType": reset_type
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

TestConnection

命令功能

测试文件服务器连通性

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.TestConnection

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Protocol": protocol,
  "Address": address,
  "Port": port,
  "UserName": user_name,
  "Password": password
}

请求头参数说明

请求体参数说明

参数	参数说明	取值
configuration	网管侧下发的配置信息	JSON字符串
protocol	连接协议的名称	支持的协议如下： ● sftp ● nfs
address	连接的对端地址	IPv4或IPv6地址
port	可选，连接对端使用的端口	如果没有则传入null，对于有默认端口的协议使用默认端口，如： ● sftp的默认端口是22 ● nfs不指定端口即可挂载
user_name	可选，连接的认证用户名	如果没有则传入null，对于无鉴权的通信协议传入null即可
password	可选，连接的认证密码	如果没有则传入null，对于无鉴权的通信协议传入null即可

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.TestConnection

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Protocol": protocol,
  "Address": address,
  "Port": port,
  "UserName": user_name,
  "Password": password
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Task.Task",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Test SFTP Connection Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2025-03-06T10:27:26+0400",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

DeleteLanguage ​

POST (ACTION) ​

RestoreFactory ​

POST (ACTION) ​

Dump ​

POST (ACTION) ​

QuickDump ​

POST (ACTION) ​

ImportConfiguration ​

POST (ACTION) ​

ExportConfiguration ​

POST (ACTION) ​

GeneralDownload ​

POST (ACTION) ​

EnterRecoveryMode ​

POST (ACTION) ​

ForceClearCMOS ​

POST (ACTION) ​

ForceRestart ​

POST (ACTION) ​

RetireSystem ​

POST (ACTION) ​

ImportRevokedVersion ​

POST (ACTION) ​

ResetToDefaults ​

POST (ACTION) ​

TestConnection ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

DeleteLanguage

POST (ACTION)

RestoreFactory

POST (ACTION)

Dump

POST (ACTION)

QuickDump

POST (ACTION)

ImportConfiguration

POST (ACTION)

ExportConfiguration

POST (ACTION)

GeneralDownload

POST (ACTION)

EnterRecoveryMode

POST (ACTION)

ForceClearCMOS

POST (ACTION)

ForceRestart

POST (ACTION)

RetireSystem

POST (ACTION)

ImportRevokedVersion

POST (ACTION)

ResetToDefaults

POST (ACTION)

TestConnection