PATCH – Update BMC Ethernet configurations
Use the PATCH method to update properties in Ethernet interface resource for a BMC.
Request URL
PATCH https://<BMC_IPADDR>/redfish/v1/Managers/1/EthernetInterfaces/NIC
Request body
Properties to be updated are shown below:
| Field | Type | Description | |||
|---|---|---|---|---|---|
InterfaceEnabled | Boolean | A boolean indicating whether this interface is enabled. | |||
MACAddress | String | The currently configured MAC address of the (logical port) interface. | |||
SpeedMbps | String | The current speed in Mbps of this XCC interface(units: Mbit/s) The property value should be between 10 and 100. | |||
AutoNeg | Boolean | Indicate if the speed and duplex are automatically negotiated and configured on this XCC interface: True. Auto negotiation of speed and duplex is enabled. False. Auto negotiation of speed and duplex is disabled. | |||
FullDuplex | Boolean | The duplex status of the Ethernet connection on this XCC interface: True. In Full Duplex mode. False. Not in Full Duplex mode. | |||
MTUSize | Number | The currently configured Maximum Transmission Unit (MTU) in bytes on this XCC interface | |||
HostName | String | The host name for this XCC interface, without any domain information. | |||
IPv4StaticAddresses | Array | An array of objects used to represent the IPv4 connection characteristics for this XCC interface | |||
IPv6StaticAddresses | Array | An array of objects used to represent the IPv6 static connection characteristics for this XCC interface | |||
IPv6StaticDefaultGateways | Array | An array of objects used to represent the IPv6 static default gateways for this XCC interface | |||
Address | String | The gateway address | |||
VLAN | Link | The value of this property shall be the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead. | |||
VLANEnable | Boolean | The property of VLAN is Enable or not. | |||
VLANId | Number | The Id of VLAN. | |||
DHCPv4 | Object | Expanded | |||
DHCPEnabled | Boolean | The DHCP is Enabled or not. | |||
UseDNSServers | Boolean | Use DNS servers or not. | |||
UseDomainName | Boolean | Use Domain Name or not. | |||
FallbackAddress | String | DHCPv4 fallback address method for this interface. Valid values: None, Static. | |||
DHCPv6 | Object | Expanded | |||
OperatingMode | String | The property of operating mode. The value should be “Stateful” or “Disabled”. | |||
UseDNSServers | Boolean | Use DNS servers or not. | |||
UseDomainName | Boolean | Use Domain Name or not. | |||
StaticNameServers | Array | Items: string Items count: 6 | |||
StatelessAddressAutoConfig | Object | Expanded | |||
IPv6AutoConfigEnabled | Boolean | Enable IPv6 Auto Config or not. | |||
Response body
The response returns same content as GET operation with updated properties.
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 400 | PropertyValueNotInList, PropertyValueFormatError, PropertyValueTypeError, PropertyNotWritable |
| 500 | InternalError |
Example
The following example is PATCH body.
{
"MTUSize": 1490,
"SpeedMbps": 100,
"FullDuplex": true
}
The resource after updated is returned.
{
"DHCPv6": {
"UseNTPServers": null,
"OperatingMode": "Disabled",
"UseDNSServers": false,
"UseDomainName": false,
"UseRapidCommit": null
},
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/1"
}
},
"VLAN": {
"VLANEnable": false,
"VLANId": 1
},
"Oem": {
"Lenovo": {
"@odata.type": "#LenovoEthernetInterface.v1_0_0.LenovoEthernetInterfaceProperties",
"DomainName": "",
"IPv4Enabled": true,
"IPv4AddressAssignedby": "Static",
"InterfaceNicMode": "Dedicated",
"NetworkSettingSync": true,
"IPv6AddressAssignedby": [],
"InterfaceFailoverMode": "Shared",
"IPv6Enabled": false
}
},
"IPv6Addresses": [],
"Status": {
"Health": null,
"State": "Enabled"
},
"IPv6DefaultGateway": "::",
"IPv6StaticDefaultGateways": [
{
"Address": "::",
"PrefixLength": 0
}
],
"StaticNameServers": [
"0.0.0.0",
"0.0.0.0",
"0.0.0.0",
"::",
"::",
"::"
],
"MTUSize": 1490,
"FullDuplex": true,
"IPv4StaticAddresses": [
{
"AddressOrigin": "Static",
"Gateway": "192.168.0.1",
"Address": "192.168.0.41",
"SubnetMask": "255.255.255.0"
}
],
"IPv6AddressPolicyTable": [
{
"Label": 0,
"Precedence": 50,
"Prefix": "::1/128"
},
{
"Label": 3,
"Precedence": 11,
"Prefix": "::/96"
},
{
"Label": 4,
"Precedence": 35,
"Prefix": "::ffff:0.0.0.0/96"
},
{
"Label": 6,
"Precedence": 10,
"Prefix": "2001::/32"
},
{
"Label": 7,
"Precedence": 10,
"Prefix": "2001:10::/28"
},
{
"Label": 12,
"Precedence": 1,
"Prefix": "3ffe::/16"
},
{
"Label": 2,
"Precedence": 30,
"Prefix": "2002::/16"
},
{
"Label": 11,
"Precedence": 1,
"Prefix": "fec0::/10"
},
{
"Label": 5,
"Precedence": 5,
"Prefix": "fc00::/7"
},
{
"Label": 1,
"Precedence": 40,
"Prefix": "::/0"
}
],
"PermanentMACAddress": "7c:d3:0a:5e:22:65",
"StatelessAddressAutoConfig": {
"IPv4AutoConfigEnabled": null,
"IPv6AutoConfigEnabled": false
},
"NameServers": [
"",
"",
"",
"::",
"::",
"::"
],
"Name": "Manager Ethernet Interface",
"AutoNeg": true,
"@odata.etag": "\"24596c8504c398d843823abc542140fa\"",
"EthernetInterfaceType": "Physical",
"MACAddress": "7c:d3:0a:5e:22:65",
"FQDN": "XCC-7X00-1234567890",
"Description": "Manager Ethernet Interface",
"@odata.type": "#EthernetInterface.v1_5_0.EthernetInterface",
"InterfaceEnabled": true,
"Id": "NIC",
"LinkStatus": "LinkUp",
"DHCPv4": {
"UseNTPServers": null,
"UseDNSServers": true,
"UseGateway": null,
"FallbackAddress": "None",
"DHCPEnabled": false,
"UseDomainName": true,
"UseStaticRoutes": null
},
"IPv6StaticAddresses": [
{
"Address": "::",
"PrefixLength": 64
}
],
"HostName": "XCC-7X00-1234567890",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/NIC",
"IPv4Addresses": [
{
"AddressOrigin": "Static",
"Gateway": "192.168.0.1",
"Address": "192.168.0.41",
"SubnetMask": "255.255.255.0"
}
],
"MaxIPv6StaticAddresses": 1,
"SpeedMbps": 100
}