EthernetInterfaces
更新时间： 2026/08/06
在AtomGit上查看源码ResourceDefinition
uris
/redfish/v1/Managers/manager_id/EthernetInterfaces/ethernetinterface_id
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | 指定BMC网口源模型的OData描述信息 |
| @odata.id | string | true | - | 指定BMC网口资源节点的访问路径 |
| @odata.type | string | true | - | 指定BMC网口资源类型 |
| Id | string | true | - | 指定BMC网口资源的ID |
| Name | string | true | - | 指定BMC网口资源的名称 |
| PermanentMACAddress | null | true | - | 指定BMC网口的MAC地址 |
| HostName | string | false | - | 指定BMC的主机名 |
| FQDN | string | false | - | 指定BMC的全称域名 |
| VLAN { | object | true | - | VLAN配置信息 |
| VLAN.VLANEnable | boolean | true | - | 指定BMC网口VLAN功能的使能状态，包括： ● true ● false |
| VLAN.VLANId | number | true | - | 指定BMC网口所属VLAN的ID |
| } | ||||
| IPv4Addresses [ { | array | false | - | 指定BMC网口的IPv4地址信息 |
| IPv4Addresses[].Address | string | true | - | 地址 |
| IPv4Addresses[].AddressOrigin | string | true | - | 地址分配方式 |
| IPv4Addresses[].SubnetMask | string | true | - | 指定BMC网口的IPv4地址对应的子网掩码 |
| IPv4Addresses[].Gateway | string | true | - | 指定BMC网口的IPv4网关地址 |
| } ] | ||||
| IPv6Addresses [ { | array | false | - | 指定BMC网口的IPv6地址信息 |
| IPv6Addresses[].Address | string | true | - | 地址 |
| IPv6Addresses[].AddressOrigin | string | true | - | 地址分配方式 |
| IPv6Addresses[].PrefixLength | number | true | - | IPv6前缀长度 |
| } ] | ||||
| IPv6DefaultGateway | string | false | - | 指定BMC网口的IPv6网关地址 |
| NameServers[ ] | array | false | - | 当前使用的DNS服务器地址。 格式为： [ "首选DNS服务器IPv4或IPv6地址", "备选DNS服务器1 IPv4或IPv6地址", "备选DNS服务器2 IPv4或IPv6地址" ] |
| StaticNameServers[ ] | array | false | - | 指定的静态DNS服务器地址。 格式为： [ "首选DNS服务器IPv4或IPv6地址", "备选DNS服务器1 IPv4或IPv6地址", "备选DNS服务器2 IPv4或IPv6地址" ] 说明指定动态模式获取DNS服务器信息时，显示为当前使用的DNS服务器地址。 |
| Oem { | object | true | - | 自定义属性 |
| Oem.Public { | object | true | - | 自定义属性 |
| Oem.Public.ManagementNetworkPort@Redfish.AllowableValues [ { | array | true | - | 管理网口的可选值 |
| Oem.Public.ManagementNetworkPort@Redfish.AllowableValues[].LinkStatus | string | true | - | 网口链路状态 ● Connected：连接 ● Disconnected：未连接 |
| Oem.Public.ManagementNetworkPort@Redfish.AllowableValues[].PortNumber | number | true | - | 丝印号说明如果是专用网口，只代表序号，不代表丝印号 |
| Oem.Public.ManagementNetworkPort@Redfish.AllowableValues[].Type | string | true | - | 网口类型 |
| } ] | ||||
| Oem.Public.SwitchConnections[ ] | array | true | - | 交换机连接信息列表 |
| Oem.Public.IPVersion | string | false | - | IPv4/IPv6协议使能 |
| Oem.Public.NetworkPortMode | string | false | - | 网口模式 |
| Oem.Public.ManagementNetworkPort { | object | false | - | 指定管理网口 |
| Oem.Public.ManagementNetworkPort.PortNumber | number | true | - | 丝印号说明如果是专用网口，只代表序号，不代表丝印号 |
| Oem.Public.ManagementNetworkPort.Type | string | true | - | 网口类型 |
| } | ||||
| Oem.Public.ManagementNetworkPortMembers [ { | array | false | - | 当前网络接口下管理的网口成员说明BMC300 5.12.0及以上版本支持 |
| Oem.Public.ManagementNetworkPortMembers[].Type | string | true | - | 网口类型 |
| Oem.Public.ManagementNetworkPortMembers[].PortNumber | number | true | - | 丝印号说明如果是专用网口，只代表序号，不代表丝印号 |
| } ] | ||||
| Oem.Public.AdaptivePort [ { | array | true | - | 自适应端口信息列表 |
| Oem.Public.AdaptivePort[].AdaptiveFlag | boolean | true | - | 自适应标志 |
| Oem.Public.AdaptivePort[].PortNumber | number | true | - | 丝印号说明如果是专用网口，只代表序号，不代表丝印号 |
| Oem.Public.AdaptivePort[].Type | string | true | - | 网口类型 |
| } ] | ||||
| Oem.Public.DNSAddressOrigin | string | false | - | DNS服务器信息获取模式 ● Static：静态模式 ● IPv4：IPv4模式 ● IPv6：IPv6模式 |
| Oem.Public.ChassisLanSubNet | string | false | - | 指定机框内部网络网段说明仅支持CIDR表示法，且子网掩码固定为16位地址如果没有内网网口，则显示为"" |
| Oem.Public.IsValidId | boolean | true | - | ID是否有效 |
| } | ||||
| } | ||||
| IPv6StaticAddresses [ { | array | true | - | IPv6静态地址列表 |
| IPv6StaticAddresses[].Address | string | true | - | 地址 |
| IPv6StaticAddresses[].PrefixLength | number | true | - | IPv6前缀长度 |
| } ] | ||||
| Link { | object | true | - | 链路配置信息 |
| Link.Oem { | object | true | - | 自定义属性 |
| Link.Oem.Public { | object | true | - | 自定义属性 |
| Link.Oem.Public.EthernetInterface { | object | true | - | 链路关联的以太网口信息 |
| Link.Oem.Public.EthernetInterface.@odata.id | string | true | - | EthernetInterface资源节点的访问路径 |
| } | ||||
| } | ||||
| } | ||||
| } | ||||
| LinkStatus | string | true | - | 网口链路状态 ● Connected：连接 ● Disconnected：未连接 |
| DHCPv4 { | object | true | - | DHCPv4配置信息 |
| DHCPv4.DHCPEnabled | boolean | false | - | 是否使能DHCPv4 |
| DHCPv4.UseNTPServers | boolean | false | - | 是否DHCP分配NTP服务器地址 |
| } | ||||
| DHCPv6 { | object | true | - | DHCPv6配置信息 |
| DHCPv6.OperatingMode | string | false | - | 当前DHCPv6的操作模式， 取值Disabled/Enabled |
| } | ||||
| IPv6Enabled | boolean | false | - | 当前网口是否使能了IPV6 |
| Links { | object | true | - | 指定BMC网口资源相关链接信息 |
| Links.Chassis { | object | true | - | 当前网口资源所在的机箱资源的访问路径 |
| Links.Chassis.@odata.id | string | true | - | Chassis资源节点的访问路径 |
| } | ||||
| } |
supported_methods
- GET
- PATCH
HTTP methods
GET
命令功能
查询指定 BMC 网口资源信息
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/ethernetinterface_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/EthernetInterfaces/ethernetinterface_id
X-Auth-Token: auth_value 请求消息体：无
响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/EthernetInterfaces/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/004207072288",
"@odata.type": "#EthernetInterface.v1_1_0.EthernetInterface",
"Id": "004207072288",
"Name": "Manager Ethernet Interface",
"LinkStatus": "LinkUp",
"PermanentMACAddress": null,
"HostName": "iBMC",
"FQDN": "iBMC",
"VLAN": {
"VLANEnable": true,
"VLANId": 60
},
"DHCPv4": {
"DHCPEnabled": true,
"UseNTPServers": false
},
"DHCPv6": {
"OperatingMode": "Enabled"
},
"IPv6Enabled": true,
"IPv4Addresses": [
{
"Address": "device_ip",
"SubnetMask": "255.255.0.0",
"Gateway": "10.10.10.1",
"AddressOrigin": "Static"
}
],
"IPv6Addresses": [
{
"Address": "fc00:0db8:3c4d:0015:0000:0000:1a2f:1a20",
"PrefixLength": 64,
"AddressOrigin": "Static"
},
{
"Address": "fe80::242:7ff:fe07:2288",
"PrefixLength": 64,
"AddressOrigin": "LinkLocal"
}
],
"IPv6StaticAddresses": [
{
"Address": "fc00:0db8:3c4d:0015:0000:0000:1a2f:1a20",
"PrefixLength": 64
}
],
"IPv6DefaultGateway": "::",
"NameServers": [
"10.10.10.254",
"10.10.10.253",
"10.10.10.252"
],
"StaticNameServers": [
"10.10.10.254",
"10.10.10.253",
"10.10.10.252"
],
"Oem": {
"Public": {
"IPVersion": "IPv4AndIPv6",
"NetworkPortMode": "Automatic",
"ManagementNetworkPort": {
"Type": "Dedicated",
"PortNumber": 1
},
"ManagementNetworkPortMembers": [
{
"Type": "Dedicated",
"PortNumber": 1
},
{
"Type": "Dedicated",
"PortNumber": 2
}
],
"ManagementNetworkPort@Redfish.AllowableValues": [
{
"Type": "Dedicated",
"PortNumber": 1,
"LinkStatus": "Connected"
},
{
"Type": "LOM",
"PortNumber": 1,
"LinkStatus": "Connected"
},
{
"Type": "LOM",
"PortNumber": 2,
"LinkStatus": "Disconnected"
},
{
"Type": "LOM",
"PortNumber": 3,
"LinkStatus": "Disconnected"
},
{
"Type": "LOM",
"PortNumber": 4,
"LinkStatus": "Disconnected"
}
],
"AdaptivePort": [
{
"Type": "Dedicated",
"PortNumber": 1,
"AdaptiveFlag": true
},
{
"Type": "LOM",
"PortNumber": 1,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 2,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 3,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 4,
"AdaptiveFlag": false
}
],
"DNSAddressOrigin": "Static",
"SwitchConnections": [],
"ChassisLanSubNet": "192.168.0.0/16",
"IsValidId": true
}
},
"Link": {
"Oem": {
"Public": {
"EthernetInterface": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
}
}
}
},
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/1"
}
}
}响应码：200
PATCH
命令功能
查询指定 BMC 网口资源信息
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/ethernetinterface_id
请求头:
X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value请求消息体:
json
{
"HostName": HostName,
"FQDN": fqdn,
"VLAN": vlan,
"IPv4Addresses": [
ipv4addr
],
"IPv6Addresses": [
ipv6addr
],
"IPv6StaticAddresses": [
ipv6staticaddr
],
"IPv6DefaultGateway": gateway6,
"NameServers": [
servers
],
"StaticNameServers": [
staticnameservers
],
"DHCPv4": {
"DHCPEnabled": [
dhcpenabled
],
"UseNTPServers": [
userntpservers
]
},
"DHCPv6": {
"OperatingMode": [
operatingmode
]
},
"IPv6Enabled": [
ipv6enabled
],
"Oem": {
"Public": {
"IPVersion": IPVersion_value,
"NetworkPortMode": NetworkPortMode_value,
"ManagementNetworkPort": ManagementNetworkPort_value,
"ManagementNetworkPortMembers": [
ManagementNetworkPortMembers_value
],
"AdaptivePort": [
AdaptivePort_value
],
"DNSAddressOrigin": DNSAddressOrigin_value,
"ChassisLanSubNet": ChassisLanSubNet_value
}
}
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| HostName | BMC的主机名 | 取值范围：1 ～ 64位的字符串取值原则：可由数字、英文字母和连字符（-）组成，且连字符不能出现在开头和结尾 |
| FQDN | BMC的全称域名。 | 格式为：主机名.域名 |
| VLAN | BMC网口的VLAN信息格式为： { "VLANEnable": state, "VLANId": vlanid } | ● state：VLAN的使能状态，可设置为“true” 和“false” ● vlanid：1~4094说明 ● vlanid只支持整数，当输入值为小数时，会上报属性格式错误 ● 仅“固定设置”模式下选择“专用网口”时， 不支持VLAN设置。其他模式下，支持使能和配置VLAN ID ● 若选择“专用网口”作为BMC管理网口，当前配置的VLAN信息不生效；若选择了除“专用网口”外的其他网口作为BMC管理网口，则当前配置的VLAN信息有效 |
| IPv4Addresses | BMC网口的IPv4地址信息格式为： { "Address":"Address", "SubnetMask":"SubnetM ask", "AddressOrigin":"Address Origin", "Gateway":"Gateway" } | ● Address：IPv4地址 ● SubnetMask：IPv4地址的子网掩码 ● AddressOrigin：IPv4地址获取模式，可设置为“Static”或 “DHCP” ● Gateway：IPv4网关地址说明 ● 当前获取模式为DHCP时，单独设置IP地址属性有效 ● 当同时设置获取模式和其他网络属性（IP地址、 网关、掩码）时，获取模式为DHCP时会报错 |
| IPv6Addresses | BMC网口的IPv6地址信息格式为： { "Address":"Address", "PrefixLength":"PrefixLen gth", "AddressOrigin":"Address Origin" } | ● Address：IPv6地址 ● PrefixLength：IPv6地址的前缀长度 ● AddressOrigin：IPv6地址获取模式，可设置为“Static”或 “DHCPv6” 说明 ● 当前获取模式为DHCPv6时，单独设置IPv6地址属性有效 ● 当同时设置获取模式和其他网络属性（IP地址、 前缀长度）时，获取模式为DHCPv6时会报错 ● IPv6地址的前缀长度只支持整数，当输入值为小数时，会报属性格式错误 |
| IPv6StaticAddresses | BMC网口的IPv6静态地址信息格式为： { "Address":"Address", "PrefixLength":"PrefixLen gth" } | ● Address：IPv6地址 ● PrefixLength：IPv6地址的前缀长度说明 ● 当IPv6的地址模式为DHCPv6时，允许设置IPv6地址、不允许设置前缀长度 ● IPv6地址的前缀长度只支持整数，当输入值为小数时，会报属性格式错误 |
| IPv6DefaultGateway | BMC网口的IPv6网关地址 | 数据类型为IPv6，表示形式为xxxx:xxxx:xxxx:xxxx:xxxx:x xxx:xxxx:xxxx当多个xxxx连续为0时，表现形式可缩写为xxxx::xxxx说明当IPv6的获取地址模式为DHCPv6时，不允许设置网关 |
| NameServers | 指定当前使用的DNS服务器地址，格式为： "首选DNS服务器IP地址"， "备选DNS服务器1 IP地址"， "备选DNS服务器2 IP地址" | 服务器的IP地址可以为IPv4或IPv6说明1. 仅DNS服务器信息获取模式为手动配置时可以修改；2. 与StaticNameServers同时配置时，配置值需要保持一致；3. 推荐以StaticNameServers属性配置首选、备选DNS服务器地址。 |
| StaticNameServers | 指定静态DNS服务器地址，格式为： "首选DNS服务器IP地址"， "备选DNS服务器1 IP地址"， "备选DNS服务器2 IP地址" | 服务器的IP地址可以为IPv4或IPv6说明1. 仅DNS服务器信息获取模式为手动配置时可以修改；2. 与NameServers同时配置时，配置值需要保持一致。 |
| IPVersion | IPv4/IPv6协议使能 | ● IPv4：只使能IPv4 ● IPv6：只使能IPv6 ● IPv4AndIPv6：IPv4和IPv6都使能 |
| NetworkPortMode | 网口模式 | ● Fixed：固定模式 ● Automatic：自动模式 |
| ManagementNetworkPort | 指定管理网口格式为 { "Type": Type, "PortNumber":PortNumb er } | ● Type：网口类型，可设置为Dedicated（专用），Aggregation （汇聚），LOM（板载），ExternalPCIe （PCIE扩展网口），LOM2（板载网卡2），OCP(OCP扩展网口) ● PortNumber：丝印说明如果是专用网口，只代表序号，不代表丝印号 |
| ManagementNetworkPortMembers | 每一个管理网口成员格式为 { "Type": Type, "PortNumber":PortNumb er } | ● Type：网口类型，可设置为Dedicated（专用），Aggregation （汇聚），LOM（板载），ExternalPCIe （PCIE扩展网口），LOM2（板载网卡2），OCP(OCP扩展网口) ● PortNumber：丝印说明如果是专用网口，只代表序号，不代表丝印号BMC300 5.12.0及以上版本支持 |
| AdaptivePort | 每一个网口的自适应信息格式为： { "Type": Type, "PortNumber": PortNumber, "AdaptiveFlag": AdaptiveFlag } | ● Type：网口类型，可设置为Dedicated（专用），Aggregation （汇聚），LOM（板载），ExternalPCIe （PCIE扩展网口），LOM2（板载网卡2），OCP(OCP扩展网口) ● PortNumber：丝印号 ● AdaptiveFlag：自适应标识，可取true或false说明如果是专用网口，只代表序号，不代表丝印号 |
| DNSAddressOrigin | DNS服务器信息获取模式 | ● IPv4：从IPv4协议栈自动获取 ● Static：手动配置 ● IPv6：从IPv6协议栈自动获取 |
| ChassisLanSubNet | 指定机框内部网络网段 | 使用CIDR表示法的IPv4地址字符串，且子网掩码固定为16位地址格式为："xxx.xxx.0.0/16" 说明如果没有内网网口，则不支持修改如果配置内网网段，网段范围不能和已有的IP地址冲突 |
| DHCPEnabled | 布尔 | 是否使能DHCPv4 |
| UseNTPServers | 布尔 | 是否DHCP分配NTP服务器地址 |
| OperatingMode | 字符串 | 当前DHCPv6的操作模式， 取值Disabled/Enabled |
| IPv6Enabled | 布尔 | 当前网口是否使能了IPV6 |
使用指南
无
使用实例
请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/ethernetinterface_id
X-Auth-Token: auth_value Content-Type: header_type If-Match: ifmatch_value 请求消息体：
json
{
"HostName": HostName,
"FQDN": fqdn,
"VLAN": vlan,
"IPv4Addresses": [
ipv4addr
],
"IPv6Addresses": [
ipv6addr
],
"IPv6StaticAddresses": [
ipv6staticaddr
],
"IPv6DefaultGateway": gateway6,
"NameServers": [
servers
],
"StaticNameServers": [
staticnameservers
],
"DHCPv4": {
"DHCPEnabled": [
dhcpenabled
],
"UseNTPServers": [
userntpservers
]
},
"DHCPv6": {
"OperatingMode": [
operatingmode
]
},
"IPv6Enabled": [
ipv6enabled
],
"Oem": {
"Public": {
"IPVersion": IPVersion_value,
"NetworkPortMode": NetworkPortMode_value,
"ManagementNetworkPort": ManagementNetworkPort_value,
"ManagementNetworkPortMembers": [
ManagementNetworkPortMembers_value
],
"AdaptivePort": [
AdaptivePort_value
],
"DNSAddressOrigin": DNSAddressOrigin_value,
"ChassisLanSubNet": ChassisLanSubNet_value
}
}
}响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/EthernetInterfaces/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/004207072288",
"@odata.type": "#EthernetInterface.v1_1_0.EthernetInterface",
"Id": "004207072288",
"Name": "Manager Ethernet Interface",
"PermanentMACAddress": null,
"HostName": "iBMC",
"LinkStatus": "LinkUp",
"FQDN": "iBMC",
"SpeedMbps": 1000,
"VLAN": {
"VLANEnable": true,
"VLANId": 60
},
"DHCPv4": {
"DHCPEnabled": true,
"UseNTPServers": false
},
"DHCPv6": {
"OperatingMode": "Enabled"
},
"IPv6Enabled": true,
"IPv4Addresses": [
{
"Address": "device_ip",
"SubnetMask": "255.255.0.0",
"Gateway": "10.10.10.1",
"AddressOrigin": "Static"
}
],
"IPv6Addresses": [
{
"Address": "fd00:60b:e3:a05:aed1:63de:c500:731a",
"PrefixLength": 64,
"AddressOrigin": "Static"
},
{
"Address": "fe80::242:7ff:fe07:2288",
"PrefixLength": 64,
"AddressOrigin": "LinkLocal"
}
],
"IPv6StaticAddresses": [
{
"Address": "fd00:60b:e3:a05:aed1:63de:c500:731a",
"PrefixLength": 64
}
],
"IPv6DefaultGateway": "::",
"NameServers": [
"10.10.10.254",
"10.10.10.253",
"10.10.10.252"
],
"StaticNameServers": [
"10.10.10.254",
"10.10.10.253",
"10.10.10.252"
],
"Oem": {
"Public": {
"IPVersion": "IPv4AndIPv6",
"NetworkPortMode": "Automatic",
"ManagementNetworkPort": {
"Type": "Dedicated",
"PortNumber": 1
},
"ManagementNetworkPortMembers": [
{
"Type": "Dedicated",
"PortNumber": 1
},
{
"Type": "Dedicated",
"PortNumber": 2
}
],
"ManagementNetworkPort@Redfish.AllowableValues": [
{
"Type": "Dedicated",
"PortNumber": 1,
"LinkStatus": "Connected"
},
{
"Type": "LOM",
"PortNumber": 1,
"LinkStatus": "Connected"
},
{
"Type": "LOM",
"PortNumber": 2,
"LinkStatus": "Disconnected"
},
{
"Type": "LOM",
"PortNumber": 3,
"LinkStatus": "Disconnected"
},
{
"Type": "LOM",
"PortNumber": 4,
"LinkStatus": "Disconnected"
}
],
"AdaptivePort": [
{
"Type": "Dedicated",
"PortNumber": 1,
"AdaptiveFlag": true
},
{
"Type": "LOM",
"PortNumber": 1,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 2,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 3,
"AdaptiveFlag": false
},
{
"Type": "LOM",
"PortNumber": 4,
"AdaptiveFlag": false
}
],
"DNSAddressOrigin": "Static",
"SwitchConnections": [],
"ChassisLanSubNet": "192.168.0.0/16",
"IsValidId": true
}
},
"Link": {
"Oem": {
"Public": {
"EthernetInterface": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
}
}
}
}
}响应码：200