ResourceDefinition

uris

/redfish/v1/Systems/system_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	指定系统资源模型的OData描述信息
@odata.id	string	true	-	指定系统资源的访问路径
@odata.type	string	true	-	指定系统资源的类型
Id	string	true	-	指定系统资源的ID
Name	string	true	-	指定系统资源的名称
AssetTag	string	false	-	指定系统资源的资产标签
Manufacturer	string	true	-	指定系统资源的制造商
Model	string	true	-	指定系统资源的型号
PowerMode	string	false	MaximumPerformance/BalancedPerformance/PowerSaving/Static/OSControlled/OEM/EfficiencyFavorPower/EfficiencyFavorPerformance	指定系统的节能模式
SerialNumber	string	true	-	指定系统资源的序列号
UUID	string	false	-	指定系统资源的全球唯一标识
SystemType	string	true	Physical	指定系统资源的系统类型
HostName	string	false	-	指定系统资源的主机名
PartNumber	string	true	-	指定系统资源的部件号
HostingRole	object	true	ApplicationServer/Switch/StorageServer	指定系统资源的主机角色
HostWatchdogTimer	object	true	-	指定系统资源的看门狗计时器功能
HostWatchdogTimer.FunctionEnabled	boolean	true	-	系统资源的看门狗使能
HostWatchdogTimer.TimeoutAction	string	true	None/OEM/PowerCycle/PowerDown/ResetSystem	系统资源的看门狗超时策略
Status	object	true	-	指定系统资源的状态，包括Health/State/Severity
PowerState	string	true	On/Off	指定系统资源的上电状态
PowerRestorePolicy	string	false	AlwayOn/LastState/AlwaysOff	通电开机策略
Boot	object	false	-	指定系统资源的启动参数
Boot.BootSourceOverrideTarget	string	false	-	系统的当前启动设备
Boot.BootSourceOverrideEnabled	string	false	Disabled/Once/Continuous	系统启动参数的使能状态
Boot.BootSourceOverrideMode	string	false	Legacy/UEFI	系统启动模式
Boot.BootSourceOverrideTarget@Redfish.AllowableValues	array	true	None/Pxe/Floppy/Cd/Hdd/BiosSetup	Redfish定义的启动设备
TrustedModules	array	true	-	指定系统资源的可信模块
TrustedModules[].FirmwareVersion	string	true	-	可信模块的固件版本
TrustedModules[].InterfaceType	string	true	TPM1_2/TPM2_0/TCM1_0	可信模块的接口类型
BiosVersion	string	true	-	指定系统资源的BIOS版本
ProcessorSummary	object	true	-	指定系统资源的CPU信息
ProcessorSummary.Count	number	true	-	CPU个数
ProcessorSummary.Model	string	true	-	CPU型号
MemorySummary	object	true	-	指定系统资源的内存信息
MemorySummary.TotalSystemMemoryGiB	number	true	-	系统总内存容量，单位为GB
GraphicalConsole	object	false	-	虚拟控制台（KVM-IP）服务的信息。BMC300 5.12.0及以上版本支持
GraphicalConsole.ConnectTypesSupported	array	true	-	支持的虚拟控制台连接类型
GraphicalConsole.MaxConcurrentSessions	number	true	-	最大会话数
GraphicalConsole.Port	number	false	-	服务的端口号
GraphicalConsole.ServiceEnabled	boolean	false	-	服务的使能状态
VirtualMediaConfig	object	false	-	虚拟媒体服务的信息。BMC300 5.12.0及以上版本支持
VirtualMediaConfig.Port	number	false	-	服务的端口号
VirtualMediaConfig.ServiceEnabled	boolean	false	-	服务的使能状态
Processors	object	true	-	处理器资源节点的访问路径
Memory	object	true	-	内存资源节点的访问路径
EthernetInterfaces	object	true	-	主机网卡资源节点的访问路径
Storage	object	true	-	存储资源节点的访问路径
NetworkInterfaces	object	true	-	网络接口资源节点的访问路径
LogServices	object	true	-	日志服务资源节点的访问路径
PCIeDevices	object	true	-	PCIe设备资源节点的访问路径
PCIeFunctions	object	true	-	PCIe功能资源节点的访问路径
Bios	object	true	-	Bios资源节点的访问路径（只有V5服务器存在）
SecureBoot	object	true	-	安全启动资源节点的访问路径
VirtualMedia	object	true	-	虚拟媒体资源访问路径
Links	object	true	-	系统资源的资源链接
Links.Chassis	array	true	-	机箱资源节点的访问路径
Links.Managers	array	true	-	管理资源的资源节点访问路径
Oem.Public	object	false	-	自定义属性
Oem.Public.HealthSummary	object	true	-	系统健康状态总览
Oem.Public.HealthSummary.CriticalAlarmCount	number	true	-	当前系统中致命告警的数量
Oem.Public.HealthSummary.MajorAlarmCount	number	true	-	当前系统中严重告警的数量
Oem.Public.HealthSummary.MinorAlarmCount	number	true	-	当前系统中轻微告警的数量
Oem.Public.ConfigurationModel	string	false	-	配置型号
Oem.Public.OSVersion	string	true	-	操作系统版本
Oem.Public.HostnameSyncEnabled	boolean	false	-	iBMA上报Hostname同步BMC使能开关
Oem.Public.CPUUsagePercent	number	true	-	CPU占用率
Oem.Public.MemoryUsagePercent	number	true	-	内存占用率
Oem.Public.LocalKvmEnabled	boolean	false	-	本地Kvm使能
Oem.Public.SafePowerOffTimeoutEnabled	boolean	false	-	下电时限使能开关
Oem.Public.SafePowerOffTimoutSeconds	number	false	-	安全下电超时时间
Oem.Public.PowerOnStrategy	string	false	TurnOn/RestorePreviousState/StayOff	通电开机策略
Oem.Public.LeakStrategy	string	false	ManualPowerOff/AutoPowerOff	液冷服务器漏液后电源控制策略
Oem.Public.PowerRestoreDelayMode	string	false	DefaultDelay/HalfDelay/FixedDelay/RandomDelay	上电延迟模式
Oem.Public.PowerRestoreDelaySeconds	number	false	-	延迟上电的时间，单位秒
Oem.Public.EnergySavingEnabled	boolean	false	-	智能节能功能使能
Actions	object	true	-	Redfish允许的指定系统资源可执行操作
Actions.#ComputerSystem.Reset	object	true	-	OS重启操作
Actions.#ComputerSystem.Reset.target	string	true	-	重启操作属性的访问路径
Actions.Oem.Public.#ComputerSystem.FruControl	object	true	-	FRU重启操作

supported_methods

GET
PATCH
POST (ACTION)

HTTP methods

GET

命令功能

查询指定系统资源信息

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
system_id	系统资源的ID	针对机架服务器取值为1；针对高密服务器取值为BladeN；针对刀片服务器取值为BladeN或SwiN；针对X6800 V5等取值还可为Enc；针对设备U位取值为UN；针对机柜取值为Rack
auth_value	执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/Systems/1

请求头：

X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
  "@odata.id": "/redfish/v1/Systems/1",
  "@odata.type": "#ComputerSystem.v1_23_0.ComputerSystem",
  "Id": "1",
  "Name": "Computer System",
  "AssetTag": null,
  "Manufacturer": "",
  "Model": null,
  "PowerMode": "BalancedPerformance",
  "SerialNumber": null,
  "UUID": "421C1E9E-1DD2-11B2-986D-0018AC640A29",
  "SystemType": "Physical",
  "HostName": null,
  "PartNumber": null,
  "HostingRole": [
    "ApplicationServer"
  ],
  "HostWatchdogTimer": {
    "FunctionEnabled": true,
    "TimeoutAction": "PowerDown"
  },
  "Status": {
    "Health": "OK",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "State": "Enabled"
  },
  "PowerState": "On",
  "PowerRestorePolicy": "LastState",
  "Boot": {
    "BootSourceOverrideTarget": "None",
    "BootSourceOverrideEnabled": "Disabled",
    "BootSourceOverrideMode": "Legacy",
    "BootSourceOverrideTarget@Redfish.AllowableValues": [
      "None",
      "Pxe",
      "Floppy",
      "Cd",
      "Hdd",
      "BiosSetup"
    ]
  },
  "TrustedModules": [
    {
      "FirmwareVersion": "v1.0",
      "InterfaceType": "TPM1_2",
      "Status": {
        "Health": "OK",
        "Oem": {
          "Public": {
            "Severity": "Informational"
          }
        },
        "state": "Absent"
      }
    }
  ],
  "BiosVersion": "3.78",
  "ProcessorSummary": {
    "Count": 1,
    "Model": "Central Processor",
    "Status": {
      "Oem": {
        "Public": {
          "Severity": "Informational"
        }
      },
      "HealthRollup": "OK"
    }
  },
  "MemorySummary": {
    "TotalSystemMemoryGiB": 8,
    "Status": {
      "Oem": {
        "Public": {
          "Severity": "Informational"
        }
      },
      "HealthRollup": "OK"
    }
  },
  "GraphicalConsole": {
    "ConnectTypesSupported": [
      "KVMIP"
    ],
    "MaxConcurrentSessions": 2,
    "Port": 2198,
    "ServiceEnabled": true
  },
  "VirtualMediaConfig": {
    "Port": 8208,
    "ServiceEnabled": true
  },
  "Processors": {
    "@odata.id": "/redfish/v1/Systems/1/Processors"
  },
  "Memory": {
    "@odata.id": "/redfish/v1/Systems/1/Memory"
  },
  "EthernetInterfaces": {
    "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
  },
  "Storage": {
    "@odata.id": "/redfish/v1/Systems/1/Storages"
  },
  "NetworkInterfaces": {
    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
  },
  "LogServices": {
    "@odata.id": "/redfish/v1/Systems/1/LogServices"
  },
  "PCIeDevices": [],
  "PCIeFunctions": [],
  "Bios": null,
  "SecureBoot": {
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot"
  },
  "VirtualMedia": {
    "@odata.id": "/redfish/v1/Systems/1/VirtualMedia"
  },
  "Links": {
    "Chassis": [
      {
        "@odata.id": "/redfish/v1/Chassis/1"
      }
    ],
    "Managers": [
      {
        "@odata.id": "/redfish/v1/Managers/1"
      }
    ]
  },
  "Oem": {
    "Public": {
      "HealthSummary": {
        "CriticalAlarmCount": 0,
        "MajorAlarmCount": 0,
        "MinorAlarmCount": 0
      },
      "ConfigurationModel": "2025V1",
      "OSVersion": null,
      "HostnameSyncEnabled": true,
      "CPUUsagePercent": 0,
      "MemoryUsagePercent": 0,
      "LocalKvmEnabled": true,
      "SafePowerOffTimeoutEnabled": true,
      "SafePowerOffTimoutSeconds": 600,
      "PowerOnStrategy": "TurnOn",
      "LeakStrategy": "ManualPowerOff",
      "PowerRestoreDelayMode": "DefaultDelay",
      "PowerRestoreDelaySeconds": 0.0,
      "EnergySavingEnabled": false
    }
  },
  "Actions": {
    "#ComputerSystem.Reset": {
      "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
    },
    "Oem": {
      "Public": {
        "#ComputerSystem.FruControl": {
          "target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl",
          "@Redfish.ActionInfo": "/redfish/v1/Systems/1/FruControlActionInfo"
        }
      }
    }
  }
}

响应码：200

PATCH

修改指定系统资源属性

命令功能

修改指定系统资源属性

参数说明

参见请求头参数说明

请求消息体

json

{
  "UUID": uuid_value,
  "HostName": hostname_value,
  "AssetTag": tag,
  "Boot": {
    "BootSourceOverrideEnabled": state,
    "BootSourceOverrideTarget": target,
    "BootSourceOverrideMode": Legacy
  },
  "PowerMode": power_mode,
  "PowerRestorePolicy": RestorePolicy,
  "GraphicalConsole": {
    "Port": 2198,
    "ServiceEnabled": true
  },
  "VirtualMediaConfig": {
    "Port": 8208,
    "ServiceEnabled": true
  },
  "Oem": {
    "Public": {
      "ConfigurationModel": configuration_model,
      "HostnameSyncEnabled": hostname_enabled,
      "CPUThresholdPercent": number,
      "MemoryThresholdPercent": number,
      "LocalKvmEnabled": LocalKvmEnabled_value,
      "SafePowerOffTimeoutEnabled": enabled_value,
      "SafePowerOffTimoutSeconds": Seconds,
      "PowerOnStrategy": Strategy,
      "LeakStrategy": power_control,
      "PowerRestoreDelayMode": Delay_mode,
      "PowerRestoreDelaySeconds": Delay_seconds,
      "EnergySavingEnabled": EnergySavingEnabled_value
    }
  }
}

请求体参数说明

参数	参数说明	取值
uuid_value	UUID	格式满足正则表达式：^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$
hostname_value	HostName	字符串
tag	自定义的资产标签	null，或1~48个字节的字符串
state	系统启动参数的使能状态	Disabled/Once/Continuous
target	系统的当前启动设备	None/Pxe/Floppy/Cd/Hdd/BiosSetup
RestorePolicy	通电开机策略	AlwayOn/LastState/AlwaysOff
power_mode	系统的节能模式	MaximumPerformance/BalancedPerformance/PowerSaving/Static/OSControlled/OEM/EfficiencyFavorPower/EfficiencyFavorPerformance
configuration_model	配置型号	字符串
hostname_enabled	iBMA上报Hostname同步BMC使能开关	true/false
number	使用率的百分比值	数字0-100
enabled_value	下电时限使能开关	布尔
Seconds	安全下电超时时间	数字
Strategy	通电策略	TurnOn/RestorePreviousState/StayOff
power_control	液冷服务器漏液后电源控制策略	ManualPowerOff/AutoPowerOff
Delay_mode	上电延迟模式	DefaultDelay/HalfDelay/FixedDelay/RandomDelay
Delay_seconds	延迟上电的时间（单位秒）	数字，保留一位小数
LocalKvmEnabled_value	本地Kvm使能	true/false
EnergySavingEnabled_value	智能节能功能使能	true/false
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET操作，从响应头中获取（对应于"ETag"参数）

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/Systems/1

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"3d607e36"

请求消息体：

json

{
  "AssetTag": "my test",
  "PowerMode": "BalancedPerformance",
  "GraphicalConsole": {
    "Port": 2198,
    "ServiceEnabled": true
  },
  "VirtualMediaConfig": {
    "Port": 8208,
    "ServiceEnabled": true
  },
  "Oem": {
    "Public": {
      "KVMSettings": {
        "PersistentUSBConnectionEnabled": true,
        "AutoOSLockEnabled": false,
        "AutoOSLockType": "Windows",
        "AutoOSLockKey": [
          ""
        ],
        "DisableKeyboardDuringBiosStartup": true
      },
      "VncSettings": {
        "DisableKeyboardDuringBiosStartup": true
      },
      "SSDMediaLifeLeftPercentThreshold": 5
    }
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
  "@odata.id": "/redfish/v1/Systems/1",
  "@odata.type": "#ComputerSystem.v1_2_0.ComputerSystem",
  "Id": "1",
  "Name": "Computer System",
  "AssetTag": "my test",
  "Manufacturer": "",
  "Model": null,
  "PowerMode": "BalancedPerformance",
  "SerialNumber": null,
  "UUID": "421C1E9E-1DD2-11B2-986D-0018AC640A29",
  "HostName": null,
  "PartNumber": null,
  "HostingRole": [
    "ApplicationServer"
  ],
  "HostWatchdogTimer": {
    "FunctionEnabled": true,
    "TimeoutAction": "PowerDown"
  },
  "Status": {
    "Health": "OK",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "State": "Enabled"
  },
  "PowerState": "On",
  "PowerRestorePolicy": "LastState",
  "Boot": {
    "BootSourceOverrideTarget": "None",
    "BootSourceOverrideEnabled": "Disabled",
    "BootSourceOverrideMode": "Legacy",
    "BootSourceOverrideTarget@Redfish.AllowableValues": [
      "None",
      "Pxe",
      "Floppy",
      "Cd",
      "Hdd",
      "BiosSetup"
    ]
  },
  "Actions": {
    "#ComputerSystem.Reset": {
      "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
    },
    "Oem": {
      "Public": {
        "#ComputerSystem.FruControl": {
          "target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl",
          "@Redfish.ActionInfo": "/redfish/v1/Systems/1/FruControlActionInfo"
        }
      }
    }
  }
}

响应码：200

POST (ACTION)

Reset

命令功能

重启服务器

说明

控制FRU上下电状态。

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Actions/ComputerSystem.Reset

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
  "ResetType": value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
value	上下电类型	On/ForceOff/GracefulShutdown/ForceRestart/Nmi/ForcePowerCycle/PowerCycle

使用指南

无

使用实例

请求样例：

http

POST https://device_ip/redfish/v1/Systems/1/Actions/ComputerSystem.Reset

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体：

json

{
  "ResetType": "On"
}

响应样例：

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

FruControl

命令功能

FRU 上下电控制

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/ComputerSystem.FruControl

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
  "FruControlType": controltype,
  "FruID": fruid
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
controltype	FRU控制类型	On/GracefulShutdown/ForceRestart/Nmi/ForcePowerCycle/PowerCycle
fruid	FRU ID	0:OS平面 1:Base平面 2:Fabric平面 3:FC平面 4:全域平面

使用指南

无

使用实例

请求样例：

http

POST https://device_ip/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体：

json

{
  "FruControlType": "On",
  "FruID": 0
}

响应样例：

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

ClearNetworkHistoryUsageRate

命令功能

清空网口历史占用率资源信息

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/ComputerSystem.ClearNetworkHistoryUsageRate

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
  "BWUWaveTitle": network_card
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
network_card	网卡标识	可通过/redfish/v1/Systems/1/NetworkHistoryUsageRate查询获取

使用指南

无

使用实例

请求样例：

http

POST https://device_ip/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ClearNetworkHistoryUsageRate

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体：

json

{
  "BWUWaveTitle": "chassisNIC1(SF221Q)"
}

响应样例：

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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

Reset ​

FruControl ​

ClearNetworkHistoryUsageRate ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

Reset

FruControl

ClearNetworkHistoryUsageRate