GET – 网络设备 PCIe 功能
使用 GET 方法检索 Redfish 服务的 NetworkDeviceFunction 资源中的属性。
请求 URL
GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/NetworkAdapters/{Locaton}/NetworkDeviceFunctions/{1-M}.{1-N}
{Location}:相应 NetworkAdapter 设备的位置。{Location}=ob-X 或 slot-Y。ob 表示板载设备,slot 表示附加卡。X 是从 1 开始的板载设备序号。Y 是附加卡的插槽编号。
{1-M}:物理网络端口的索引。
{1-N}:逻辑网络端口的索引。
请求正文
无
响应正文
字段 | 类型 | 描述 | ||||
---|---|---|---|---|---|---|
Id | 字符串 | 相关 NetworkPort 资源的物理端口索引 +“.”+ 逻辑端口索引。 | ||||
AssignablePhysicalPorts | 数组 | 项:链接 | ||||
AssignablePhysicalPorts[N] | 链接 | 可能端口的链接 | ||||
PhysicalNetworkPortAssignment | 链接 | 相关 NetworkPort 的链接。 | ||||
Description | 字符串 | “A Network Device Function represents a logical interface exposed by the network adapter.” | ||||
DeviceEnabled | 布尔 | True | ||||
InfiniBand | 对象 | 展开。(如果这是 InfiniBand,则将显示下面的项) | ||||
PermanentPortGUID | 字符串 | 分配给此网络设备功能的永久端口 GUID。 | ||||
MTUSize | 数字 | 为此网络设备功能配置的最大传输单元(MTU)。 | ||||
Ethernet | 对象 | 展开。(如果这是 Ethernet,则将显示下面的项) | ||||
PermanentMACAddress | 字符串 | 这是分配给此网络设备功能(物理功能)的永久 MAC 地址 | ||||
MACAddress | 字符串 | 这是(逻辑端口)网络设备功能当前配置的 MAC 地址。 | ||||
MTUSize | 数字 | 为此网络设备功能配置的最大传输单元(MTU)。 | ||||
FibreChannel | 对象 | 展开。(如果这是 FibreChannel,则将显示下面的项) | ||||
PermanentWWPN | 字符串 | 这是分配给此网络设备功能(物理功能)的永久 WWPN 地址。 | ||||
WWPN | 字符串 | 这是网络设备功能(物理功能)当前配置的 WWPN 地址。 | ||||
Links | 对象 | 展开。 | ||||
EthernetInterface | 链接 | 以太网接口的链接 | ||||
PCIeFunction | 链接 | PCIeFunction 的链接 | ||||
PhysicalPortAssignment | 链接 | 相关 NetworkPort 的链接 | ||||
Name | 字符串 | “Logical Port”+“ ”+逻辑端口索引 | ||||
NetDevFuncType | 字符串 | 此网络设备功能配置的功能。 | ||||
Status | 对象 | 展开 | ||||
State | 字符串 | Enabled | ||||
Health | 字符串 | OK | ||||
HealthRollup | 字符串 | 表示此资源及其依赖资源的运行状况状态。 | ||||
@Redfish.Settings | 对象 | 已展开 仅当 NetDevFuncType 为 iSCSI 时,才支持此对象。 | ||||
Messages | 数组 | 项:对象 | ||||
Messages[N] | 对象 | 已展开 | ||||
MessageId | 字符串 | “RebootRequired” | ||||
RelatedProperties | 数组 | 项:字符串 | ||||
RelatedProperties[N] | 字符串 | 网络设备功能的设置名称。格式将为“#/iSCSIBoot/…”。 | ||||
Severity | 字符串 | “Warning” | ||||
Message | 字符串 | “Changes completed successfully, but these changes will not take effect until next reboot.” | ||||
Resolution | 字符串 | “Reboot the computer system for the changes to take effect.” | ||||
SettingsObject | 链接 | 网络设备功能设置暂挂资源的链接。 | ||||
Time | 字符串 | 指示上次应用设置资源的时间。 | ||||
SupportedApplyTimes | 数组 | 项:字符串 项数:1 | ||||
SupportedApplyTimes[0] | 字符串 | “OnReset” | ||||
iSCSIBoot | 对象 | 已展开。 仅当 NetDevFuncType 为“iSCSI”时,才支持此属性。 | ||||
AuthenticationMethod | 字符串 | 此网络设备功能的 iSCSI 引导认证方法。 | ||||
CHAPSecret | 字符串 | 用于 CHAP 认证的共享密钥。仅当 AuthenticationMethod 为 CHAP 时才存在。 | ||||
CHAPUsername | 字符串 | 用于 CHAP 认证的用户名。仅当 AuthenticationMethod 为 CHAP 时才存在。 | ||||
IPAddressType | 字符串 | 在 iSCSIBoot IP 地址字段中填入的 IP 地址的类型。 有效值:“IPv4”、“IPV6” | ||||
InitiatorDefaultGateway | 字符串 | IPv6 或 IPv4 iSCSI 引导默认网关。 | ||||
InitiatorIPAddress | 字符串 | IPv6 或 IPv4 iSCSI 引导默认网关。 | ||||
InitiatorName | 字符串 | iSCSI 发起方名称。 | ||||
InitiatorNetmask | 字符串 | iSCSI 引导发起方的 IPv6 或 IPv4 网络掩码。 | ||||
MutualCHAPSecret | 字符串 | 用于双向 CHAP 认证的 CHAP 密钥。仅当 AuthenticationMethod 为 MutualCHAP 时才存在。 | ||||
MutualCHAPUsername | 字符串 | 用于双向 CHAP 认证的 CHAP 用户名。仅当 AuthenticationMethod 为 MutualCHAP 时才存在。 | ||||
PrimaryLUN | 数字 | 主 iSCSI 引导目标的逻辑单元号(LUN)。 | ||||
PrimaryTargetIPAddress | 字符串 | 主 iSCSI 引导目标的 IPv4 或 IPv6 地址。 | ||||
PrimaryTargetName | 字符串 | iSCSI 主引导目标的名称。 | ||||
PrimaryTargetTCPPort | 数字 | 主 iSCSI 引导目标的 TCP 端口。 | ||||
TargetInfoViaDHCP | 布尔 | 指示是否应从 DHCP 获取 iSCSI 引导目标名称、LUN、IP 地址和网络掩码。 |
状态代码
HTTP 状态代码 | 错误消息 ID |
---|---|
500 | InternalError |
示例
返回以下示例 JSON 响应:
{
"NetDevFuncType": "Ethernet",
"Ethernet": {
"PermanentMACAddress": "90:2e:16:05:4d:7c",
"MTUSize": 72000,
"MACAddress": "90:2e:16:05:4d:7c"
},
"PhysicalNetworkPortAssignment": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
},
"AssignablePhysicalPorts@odata.count": 2,
"@odata.type": "#NetworkDeviceFunction.v1_8_0.NetworkDeviceFunction",
"DeviceEnabled": true,
"Name": "Logical Port 1",
"@odata.context": "/redfish/v1/$metadata#NetworkDeviceFunction.NetworkDeviceFunction",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/NetworkDeviceFunctions/2.1",
"Links": {
"EthernetInterface": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/NIC2"
},
"PhysicalNetworkPortAssignment": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
},
"PCIeFunction": {
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2/PCIeFunctions/ob_2.01"
}
},
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"Id": "2.1",
"@odata.etag": "\"83405fffeb4731d4f240e\"",
"Description": "A Network Device Function represents a logical interface exposed by the network adapter.",
"AssignablePhysicalPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
}
]
}