代码仓
SystemAssembly
更新时间: 2026/09/07
在AtomGit上查看源码

ResourceDefinition

uris

  • /redfish/v1/Oem/Huawei/Public/SystemAssembly

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-SystemAssembly资源模型的OData描述信息
@odata.idstringtrue-SystemAssembly资源节点的访问路径
@odata.typestringtrue-SystemAssembly资源类型
Idstringtrue-SystemAssembly资源的ID
Namestringtrue-SystemAssembly资源的名称
Systemsarraytrue-多主机系统列表
Systems[].SystemIdstringtrue-多主机系统中系统资源的ID
Systems[].BiosSettings.Attributesobjecttrue-BIOS设置资源当前设置的属性列表
Systems[].Boot.BootSourceOverrideTargetstringtrue-系统的当前启动设备
Systems[].Boot.BootSourceOverrideEnabledstringtrue-系统启动参数的使能状态,包括:
● Disabled:不生效
● Once:仅生效一次,即下次重启时生效
● Continuous:永久有效
Systems[].Boot.BootSourceOverrideModestringtrue-系统启动模式,包括:
● Legacy
● UEFI
Systems[].Boot.BootSourceOverrideTarget@Redfish.AllowableValuesarraytrue-Redfish定义的启动设备,包括:
● None
● Pxe
● Floppy
● Cd
● Hdd
● BiosSetup
Systems[].PowerStatestringtrue-指定系统资源的上电状态,包括:
● On
● Off
Actionsobjecttrue-Redfish允许的指定SystemAssembly资源可执行操作
Actions.#SystemAssembly.Resetobjecttrue-多主机系统上下电操作
Actions.#SystemAssembly.Reset.targetstringtrue-多主机系统上下电操作的路径
Actions.#SystemAssembly.Reset.@Redfish.ActionInfostringtrue-多主机系统上下电操作的查询路径
Actions.#SystemAssembly.ResetBootCertobjecttrue-多主机系统重置BIOS启动证书操作
Actions.#SystemAssembly.ResetBootCert.targetstringtrue-多主机系统重置BIOS启动证书的路径
Actions.#SystemAssembly.ResetBootCert.@Redfish.ActionInfostringtrue-多主机系统重置BIOS启动证书的查询路径
Actions.#SystemAssembly.ImportBootCertobjecttrue-多主机系统导入BIOS启动证书操作
Actions.#SystemAssembly.ImportBootCert.targetstringtrue-多主机系统导入BIOS启动证书的路径
Actions.#SystemAssembly.ImportBootCert.@Redfish.ActionInfostringtrue-多主机系统导入BIOS启动证书的查询路径

supported_methods

  • GET
  • PATCH
  • POST

HTTP methods

GET

命令功能

查询多主机系统接口汇聚信息

命令格式

URL: https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly

请求头:


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

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value执行该GET请求时,必须在"Headers"中携带"X-Auth-Token"值用于鉴权可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

仅GA140C机型支持。

使用实例

请求样例:

http
GET https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly

请求头:


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

请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#SystemAssembly.SystemAssembly",
  "@odata.type": "#SystemAssembly.v1_0_0.SystemAssembly",
  "@odata.id": "/redfish/v1/Oem/Huawei/Public/SystemAssembly",
  "Id": "SystemAssembly",
  "Name": "System Assembly",
  "Systems": [
    {
      "SystemId": "1",
      "BiosSettings": {
        "Attributes": {}
      },
      "Boot": {
        "BootSourceOverrideTarget": null,
        "BootSourceOverrideEnabled": null,
        "BootSourceOverrideMode": null,
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
          "None",
          "Pxe",
          "Floppy",
          "Cd",
          "Hdd",
          "BiosSetup"
        ]
      },
      "PowerState": "On"
    },
    {
      "SystemId": "2",
      "BiosSettings": {
        "Attributes": {}
      },
      "Boot": {
        "BootSourceOverrideTarget": null,
        "BootSourceOverrideEnabled": null,
        "BootSourceOverrideMode": null,
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
          "None",
          "Pxe",
          "Floppy",
          "Cd",
          "Hdd",
          "BiosSetup"
        ]
      },
      "PowerState": "On"
    }
  ],
  "Actions": {
    "#SystemAssembly.Reset": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ResetActionInfo"
    },
    "#SystemAssembly.ResetBootCert": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ResetBootCert",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ResetBootCertActionInfo"
    },
    "#SystemAssembly.ImportBootCert": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ImportBootCert",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ImportBootCertActionInfo"
    }
  }
}

响应码:200

PATCH

命令功能

修改多主机系统BIOS配置项以及启动配置信息

命令格式

URL: https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json
{
  "Systems": [
    {
      "SystemId": "1",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideMode": "Legacy"
      }
    },
    {
      "SystemId": "2",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4IPv6"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideMode": "UEFI"
      }
    }
  ]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
ifmatch_value请求消息的匹配参数可通过对相应资源发起GET操作,从响应头中获取(对应于"ETag"参数)
Systems多主机系统列表数组
SystemId多主机系统中系统资源的ID字符串
BiosSettings.AttributesBIOS设置资源当前设置的属性列表请参考/redfish/v1/Systems/system_id/Bios接口属性说明
BiosSettings.Attributes.NetworkProtocolBIOS系统配置中网络协议枚举值:
● UEFIIPv4
● UEFIIPv4IPv6
Boot.BootSourceOverrideTarget系统的当前启动设备字符串
Boot.BootSourceOverrideEnabled系统启动参数的使能状态枚举值:
● Disabled:不生效
● Once:仅生效一次,即下次重启时生效
● Continuous:永久有效
Boot.BootSourceOverrideMode系统启动模式枚举值:
● Legacy
● UEFI

使用指南

仅GA140C机型支持。

使用实例

请求样例:

http
PATCH https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly

请求头:


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

请求消息体:

json
{
  "Systems": [
    {
      "SystemId": "1",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideMode": "Legacy"
      }
    },
    {
      "SystemId": "2",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4IPv6"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideMode": "UEFI"
      }
    }
  ]
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#SystemAssembly.SystemAssembly",
  "@odata.type": "#SystemAssembly.v1_0_0.SystemAssembly",
  "@odata.id": "/redfish/v1/Oem/Huawei/Public/SystemAssembly",
  "Id": "SystemAssembly",
  "Name": "System Assembly",
  "Systems": [
    {
      "SystemId": "1",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideMode": "Legacy",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
          "None",
          "Pxe",
          "Floppy",
          "Cd",
          "Hdd",
          "BiosSetup"
        ]
      },
      "PowerState": "On"
    },
    {
      "SystemId": "2",
      "BiosSettings": {
        "Attributes": {
          "NetworkProtocol": "UEFIIPv4IPv6"
        }
      },
      "Boot": {
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideMode": "UEFI",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
          "None",
          "Pxe",
          "Floppy",
          "Cd",
          "Hdd",
          "BiosSetup"
        ]
      },
      "PowerState": "On"
    }
  ],
  "Actions": {
    "#SystemAssembly.Reset": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ResetActionInfo"
    },
    "#SystemAssembly.ResetBootCert": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ResetBootCert",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ResetBootCertActionInfo"
    },
    "#SystemAssembly.ImportBootCert": {
      "target": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ImportBootCert",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Huawei/Public/SystemAssembly/ImportBootCertActionInfo"
    }
  }
}

响应码:200

POST (ACTION)

SystemAssembly.Reset

命令功能

执行多主机系统批量电源复位操作

命令格式

URL: https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.Reset

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "ResetType": "ForceOff"
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
SystemId批量执行电源复位操作的系统ID集合非必需参数,可选填如下几个使用方式:
● 多主机系统包括的系统所有ID的集合中的一个或多个唯一值,例如:8个主机系统,取值范围为["1" ~ "8"]
● 无此参数,默认使用["1"]
ResetType对多个系统进行的复位类型必需参数,OS重启操作,包括:
● On
● ForceOff
● GracefulShutdown
● ForceRestart
● Nmi
● ForcePowerCycle
● PowerCycle

使用指南

仅GA140C机型支持。

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.Reset

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "ResetType": "ForceOff"
}

响应样例:

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)

SystemAssembly.ResetBootCert

命令功能

重置多主机系统BIOS的启动证书

命令格式

URL: https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ResetBootCert

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "ResetKeysType": "DeleteAllKeys"
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
SystemId批量执行电源复位操作的系统ID集合非必需参数,可选填如下几个使用方式:
● 多主机系统包括的系统所有ID的集合中的一个或多个唯一值,例如:8个主机系统,取值范围为["1" ~ "8"]
● 无此参数,默认使用["1"]
ResetKeysType对多个系统进行的复位类型必需参数,支持的类型包括:
● DeleteAllKeys:删除对应类型所有证书
● ResetAllKeysToDefault:恢复对应类型的证书到默认值
说明:当参数为ResetAllKeysToDefault时,如果没有相关初始证书,则该操作等同于DeleteAllKeys。初始证书的支持情况请参考对应机型的《BIOS参数参考》

使用指南

仅GA140C机型支持。

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ResetBootCert

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "ResetKeysType": "DeleteAllKeys"
}

响应样例:

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)

SystemAssembly.ImportBootCert

命令功能

导入多主机系统启动证书

命令格式

URL: https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ImportBootCert

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "CertificateType": "certificate_type",
  "CertificateString": "certificate_string"
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
SystemId批量执行电源复位操作的系统ID集合非必需参数,可选填如下几个使用方式:
● 多主机系统包括的系统所有ID的集合中的一个或多个唯一值,例如:8个主机系统,取值范围为["1" ~ "8"]
● 无此参数,默认使用["1"]
CertificateType证书类型可选参数,支持的类型包括:
● PEM:表示PEM编码的单一证书
说明:不输入此参数时将默认为PEM类型
CertificateString证书文本证书文本,其类型由CertificateType指定

使用指南

仅GA140C机型支持。

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/Huawei/Public/SystemAssembly/Actions/SystemAssembly.ImportBootCert

请求头:


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

请求消息体:

json
{
  "SystemId": ["1", "2"],
  "CertificateType": "certificate_type",
  "CertificateString": "certificate_string"
}

响应样例:

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