LCNDevice
更新时间: 2025/05/25
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/Oem/LCNService/LCNDevices/device_id

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-指定LCN设备资源模型的OData描述信息
@odata.idstringtrue-指定LCN设备资源的访问路径
@odata.typestringtrue-指定LCN设备资源的类型
Idstringtrue-指定LCN设备资源ID
Namestringtrue-指定LCN设备资源名称
Descriptionstringtrue-指定LCN设备的描述信息
SlotNumbernumbertrue-指定LCN设备的槽位号
Statusobjecttrue-指定LCN设备的状态
Status.StatestringtrueEnabled、Disabled指定LCN设备的使能状态
Status.HealthstringtrueOK、Warning、Critical指定LCN设备的健康状态
Status.SeveritystringtrueInformational、Minor、Major、Critical指定LCN设备的自定义健康状态
Manufacturerstringtrue-指定LCN设备的生产厂商,默认为空字符串
ProductNamestringtrue-指定LCN设备的产品名称,默认为空字符串
SerialNumberstringtrue-指定LCN设备的序列号,默认为空字符串
PartNumberstringtrue-指定LCN设备的部件号,默认为空字符串
MemorySizeMiBnumbertrue-指定LCN设备的系统内存大小,单位为MB
FlashSizeMiBnumbertrue-指定LCN设备的闪存大小,单位为MB
SoftwareVersionstringtrue-指定LCN设备的软件版本,默认为空字符串
PatchVersionstringtrue-指定LCN设备的补丁版本,默认为空字符串
PCBVersionstringtrue-指定LCN设备的PCB版本,默认为空字符串
MABVersionstringtrue-指定LCN设备的制成板版本,默认为空字符串
BiosVersionstringtrue-指定LCN设备的BIOS版本,默认为空字符串
LogicDevicesarraytrue-指定LCN设备上所有逻辑器件信息显示,默认为空数组
LogicDevices[].Namestringtrue-逻辑器件名称
LogicDevices[].Versionstringtrue-逻辑器件版本号
ManagedByBMCbooleanfalse-指定LCN设备是否被BMC管理,默认为false
EventRecieveEnabledbooleanfalse-指定LCN设备事件是否被BMC接收,默认为false
IsManagedbooleantrue-指定LCN设备当前是否被BMC成功管理,默认为false。BMC300 5.8.3.55及以上版本,A800T A3,A800I A3机型支持
SubCardsobjecttrue-指定LCN设备子卡集合的资源。包含指向资源的链接
SubCards.@odata.idstringtrue-指定LCN设备子卡集合资源的路径链接
NetworkInterfacesarraytrue-指定LCN设备的网络接口信息,默认为空数组
NetworkInterfaces[].Interfacestringfalse-网络接口的名称
NetworkInterfaces[].VPNstringfalse-网络接口绑定的VPN实例
NetworkInterfaces[].IPv4Addressesobjectfalse-网络接口的IPv4地址信息
NetworkInterfaces[].IPv4Addresses.Addressstringfalse-网络接口的IPv4地址
NetworkInterfaces[].IPv4Addresses.SubnetMaskstringfalse-网络接口的IPv4地址对应的子网掩码
Accountsobjecttrue-指定LCN设备的用户资源。包含指向资源的链接
Accounts[].@odata.idstringtrue-指定LCN设备用户资源的路径链接
UpdateServiceobjecttrue-指定LCN设备的升级资源。包含指向资源的链接
UpdateService.@odata.idstringtrue-指定LCN设备升级资源的路径链接
Actionsobjecttrue-指定LCN设备可执行的操作
Actions.#LCN.ExportLogobjecttrue-导出指定LCN设备日志
Actions.#LCN.ExportLog.targetstringtrue-导出指定LCN设备日志动作的访问路径
Actions.#LCN.ExportLog.@Redfish.ActionInfostringtrue-导出指定LCN设备日志参数的查询路径
Actions.#LCN.SetInnerNetworkobjecttrue-设置与指定LCN设备通信的内部网络
Actions.#LCN.SetInnerNetwork.targetstringtrue-设置与指定LCN设备通信的内部网络动作的访问路径
Actions.#LCN.SetInnerNetwork.@Redfish.ActionInfostringtrue-设置与指定LCN设备通信的内部网络参数的查询路径
Actions.#LCN.SetNetworkInterfaceobjecttrue-设置指定LCN设备的网络接口
Actions.#LCN.SetNetworkInterface.targetstringtrue-设置指定LCN设备的网络接口动作的访问路径
Actions.#LCN.SetNetworkInterface.@Redfish.ActionInfostringtrue-设置指定LCN设备的网络接口参数的查询路径
Actions.#LCNDevice.Resetobjecttrue-重启指定LCN设备
Actions.#LCNDevice.Reset.targetstringtrue-重启指定LCN设备动作的访问路径
Actions.#LCNDevice.Reset.@Redfish.ActionInfostringtrue-重启指定LCN设备参数的查询路径
Actions.#LCNDevice.ResetToDefaultsobjecttrue-重启指定的LCN设备并恢复默认出厂配置的网络接口
Actions.#LCNDevice.ResetToDefaults.targetstringtrue-重启指定的LCN设备并恢复默认出厂配置动作的访问路径
Actions.#LCNDevice.ResetToDefaults.@Redfish.ActionInfostringtrue-重启指定的LCN设备并恢复默认出厂配置参数的查询路径

supported_methods

  • GET
  • PATCH
  • POST

HTTP methods

GET

命令功能

查询指定 LCN 设备信息

说明

BMC300 5.8.3.27及以上版本,A900 A3 SuperPoD,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id

请求头:


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

请求消息体: 无

参数说明

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

使用指南

使用实例

请求样例:

http
GET https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1

请求头:


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

请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#LCNDevice.LCNDevice",
  "@odata.id": "/redfish/v1/Oem/LCNDevices/LinkBoard1",
  "@odata.type": "#LCNDevice.v1_0_0.LCNDevice",
  "Id": "LinkBoard1",
  "Name": "LinkBoard1",
  "Description": "132*200G 56*QSFPDD, Without Fan and Power Module",
  "SlotNumber": 1,
  "Status": {
    "State": "Enabled",
    "Health": "OK",
    "Severity": "Informational"
  },
  "Manufacturer": "",
  "ProductName": "LQC313-L1",
  "SerialNumber": "2102353EGQ10MB000009",
  "PartNumber": "02315BXE",
  "MemorySizeMiB": 16384,
  "FlashSizeMiB": 4096,
  "SoftwareVersion": "V100R024C00SPC500",
  "PatchVersion": "V100R006SPH001",
  "PCBVersion": "IT22SMMB VER C",
  "MABVersion": "3",
  "BiosVersion": "1090",
  "LogicDevices": [
    {
      "Name": "CPLD1",
      "Version": "1288"
    }
  ],
  "ManagedByBMC": true,
  "EventRecieveEnabled": true,
  "IsManaged": true,
  "SubCards": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SubCards"
  },
  "NetworkInterfaces": [
    {
      "Interface": "MEth0/0/0",
      "VPN": "_management_vpn_",
      "IPv4Addresses": {
        "Address": "192.168.2.100",
        "SubnetMask": "255.255.255.0"
      }
    }
  ],
  "Accounts": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Accounts"
  },
  "UpdateService": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/UpdateService"
  },
  "Actions": {
    "#LCN.ExportLog": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.ExportLog",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ExportLogActionInfo"
    },
    "#LCN.SetInnerNetwork": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetInnerNetwork",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SetInnerNetworkActionInfo"
    },
    "#LCN.SetNetworkInterface": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetNetworkInterface",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SetNetworkInterfaceActionInfo"
    },
    "#LCNDevice.Reset": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ResetActionInfo"
    },
    "#LCNDevice.ResetToDefaults": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.ResetToDefaults",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ResetToDefaultsActionInfo"
    }
  }
}

响应码:200

PATCH

命令功能

修改指定 LCN 设备信息

说明

BMC300 5.8.3.27及以上版本,A900 A3 SuperPoD,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id

请求头:


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

请求消息体:

json
{
  "ManagedByBMC": managed_by_bmc,
  "EventRecieveEnabled": event_recieve_enabled
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
ifmatch_value请求消息的匹配参数可通过对相应资源发起GET操作,从响应头中获取(对应于"ETag"参数)
ManagedByBMC指定LCN设备是否被BMC管理,可选参数,默认为false● true: 开启
● false: 关闭
EventRecieveEnabled指定LCN设备事件是否被BMC接收,可选参数,默认为false。仅ManagedByBMC开启时设置有效。关闭ManagedByBMC时将自动关闭EventRecieveEnabled● true: 开启
● false: 关闭

使用指南

使用实例

请求样例:

http
PATCH https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1

请求头:


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

请求消息体:

json
{
  "ManagedByBMC": true,
  "EventRecieveEnabled": true
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#LCNDevice.LCNDevice",
  "@odata.id": "/redfish/v1/Oem/LCNDevices/LinkBoard1",
  "@odata.type": "#LCNDevice.v1_0_0.LCNDevice",
  "Id": "LinkBoard1",
  "Name": "LinkBoard1",
  "Description": "132*200G 56*QSFPDD, Without Fan and Power Module",
  "SlotNumber": 1,
  "Status": {
    "State": "Enabled",
    "Health": "OK",
    "Severity": "Informational"
  },
  "Manufacturer": "",
  "ProductName": "LQC313-L1",
  "SerialNumber": "2102353EGQ10MB000009",
  "PartNumber": "02315BXE",
  "MemorySizeMiB": 16384,
  "FlashSizeMiB": 4096,
  "SoftwareVersion": "V100R024C00SPC500",
  "PatchVersion": "V100R006SPH001",
  "PCBVersion": "IT22SMMB VER C",
  "MABVersion": "3",
  "BiosVersion": "1090",
  "LogicDevices": [
    {
      "Name": "CPLD1",
      "Version": "1288"
    }
  ],
  "ManagedByBMC": true,
  "EventRecieveEnabled": true,
  "IsManaged": true,
  "SubCards": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SubCards"
  },
  "NetworkInterfaces": [
    {
      "Interface": "MEth0/0/0",
      "VPN": "_management_vpn_",
      "IPv4Addresses": {
        "Address": "192.168.2.100",
        "SubnetMask": "255.255.255.0"
      }
    }
  ],
  "Accounts": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Accounts"
  },
  "UpdateService": {
    "@odata.id": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/UpdateService"
  },
  "Actions": {
    "#LCN.ExportLog": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.ExportLog",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ExportLogActionInfo"
    },
    "#LCN.SetInnerNetwork": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetInnerNetwork",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SetInnerNetworkActionInfo"
    },
    "#LCN.SetNetworkInterface": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetNetworkInterface",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/SetNetworkInterfaceActionInfo"
    },
    "#LCNDevice.Reset": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.Reset",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ResetActionInfo"
    },
    "#LCNDevice.ResetToDefaults": {
      "target": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.ResetToDefaults",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/ResetToDefaultsActionInfo"
    }
  }
}

响应码:200

POST (ACTION)

ExportLog

命令功能

导出指定 LCN 设备日志

说明

BMC300 5.8.3.27及以上版本,A900 A3 SuperPoD,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id/Actions/LCN.ExportLog

请求头:


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

请求消息体:

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

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
Type导出日志的方法URI
Content导出日志文件的路径● 本地导出:"/tmp/文件名"
● 远程导出:"sftp://用户名:用户密码@{IP}/目录/文件名"
● 文件传输协议包括五种:sftp、https、nfs、cifs、scp

使用指南

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.ExportLog

请求头:


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

本地导出请求消息体:

json
{
  "Type": "URI",
  "Content": "/tmp/diagnostic_information.zip"
}

远程导出请求消息体:

json
{
  "Type": "URI",
  "Content": "sftp://username:password@10.10.10.191/usr/diagnostic_information.zip"
}

响应样例:

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": "LCN ExportLog Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2025-02-15T10:36+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "": {
      "TaskPercentage": null
    }
  }
}

响应码:202

POST (ACTION)

SetInnerNetwork

命令功能

设置与指定 LCN 设备通信的内部网络

说明

BMC300 5.8.3.27及以上版本,A900 A3 SuperPoD,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id/Actions/LCN.SetInnerNetwork

请求头:

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

请求消息体:

json
{
  "IPv4Addresses": {
    "Address": address_value,
    "SubnetMask": mask_value
  }
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
IPv4AddressesIPv4地址对象-
IPv4Addresses.Address指定IPv4地址点分十进制格式,例如:"192.168.64.210"
IPv4Addresses.SubnetMask指定IPv4地址对应的子网掩码点分十进制格式,例如:"255.255.255.0"

使用指南

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetInnerNetwork

请求头:


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

请求消息体:

json
{
  "IPv4Addresses": {
    "Address": "192.168.64.210",
    "SubnetMask": "255.255.255.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

POST (ACTION)

SetNetworkInterface

命令功能

设置指定 LCN 设备的网络接口

说明

BMC300 5.8.3.27及以上版本,A900 A3 SuperPoD,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id/Actions/LCN.SetNetworkInterface

请求头:


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

请求消息体:

json
{
  "Interface": interface_name,
  "VPN": vpn_name,
  "IPv4Addresses": {
    "Address": address_value,
    "SubnetMask": mask_value,
    "BMCSaveOnly": bmc_save_only
  }
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
Interface将要设置的网络接口名称可通过指定LCN设备资源获取,例如:"MEth0/0/0"
VPN设置指定网络接口的VPN,可选参数,单独设置IP时可以不设置VPN指定vpn实例,例如:"management_vpn"
IPv4AddressesIPv4地址对象-
IPv4Addresses.Address指定接口IPv4地址,可选参数,单独设置VPN时可以不设置IP点分十进制格式,例如:"192.168.64.212"
IPv4Addresses.SubnetMask指定接口IPv4地址对应的子网掩码,可选参数,单独设置VPN时可以不设置IP点分十进制格式,例如:"255.255.255.0"
IPv4Addresses.BMCSaveOnly是否仅修改BMC保存的LCN设备内部通信IP,可选参数,默认为false,仅对内部通信网络接口生效● true:仅设置BMC保存的LCN设备内部通信IP
● false:设置的网络接口配置将同步到LCN设备

使用指南

内部通信网口不支持设置VPN。BMCSaveOnly仅对内部通信网口生效。

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCN.SetNetworkInterface

请求头:


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

请求消息体:

json
{
  "Interface": "MEth0/0/0",
  "VPN": "_management_vpn_",
  "IPv4Addresses": {
    "Address": "192.168.64.212",
    "SubnetMask": "255.255.255.0",
    "BMCSaveOnly": false
  }
}

响应样例:

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)

Reset

命令功能

重启指定 LCN 设备

说明

BMC300 5.8.3.51及以上版本,A800T A3,A800I A3机型支持

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id/Actions/LCNDevice.Reset

请求头:


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

请求消息体:

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

使用指南

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.Reset

请求头:


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

请求消息体:

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)

ResetToDefaults

命令功能

重启指定 LCN 设备并恢复默认出厂配置

说明

BMC300 5.8.3.51及以上版本,A800T A3,A800I A3机型支持,仅支持管理员用户操作

命令格式

URL: https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/device_id/Actions/LCNDevice.ResetToDefaults

请求头:


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

请求消息体:

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

使用指南

指定LCN设备重启后会恢复默认出厂配置。

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Oem/LCNService/LCNDevices/LinkBoard1/Actions/LCNDevice.ResetToDefaults

请求头:


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

请求消息体:

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