Skip to main content

PATCH – Update BMC Ethernet over USB 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/ToHost

Request body

Properties to be updated are shown as bellow, all of these properties can be changed individually.

FieldTypeError Message ID

InterfaceEnabled

BooleanA boolean indicating whether this interface is enabled.

IPv4StaticAddresses

ArrayAn array of objects used to represent the IPv4 connection characteristics for this XCC interface. Only the static IPv4 address can be updated.

Response body

The response returns same content as GET operation with updated properties.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example is PATCH body.

{
"InterfaceEnabled" : true,
"IPv4StaticAddresses" : [
{
"Address": "169.254.95.119",
"SubnetMask": "255.255.0.0"
}
]
}

The resource after updated is returned.

{
"FQDN": "",
"Id": "ToHost",
"InterfaceEnabled": true,
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/1"
},
"HostInterface": {
"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1"
}
},
"AutoNeg": false,
"IPv6AddressPolicyTable": [
{
"Precedence": 50,
"Prefix": "::1/128",
"Label": 0
},
{
"Precedence": 11,
"Prefix": "::/96",
"Label": 3
},
{
"Precedence": 35,
"Prefix": "::ffff:0.0.0.0/96",
"Label": 4
},
{
"Precedence": 10,
"Prefix": "2001::/32",
"Label": 6
},
{
"Precedence": 10,
"Prefix": "2001:10::/28",
"Label": 7
},
{
"Precedence": 1,
"Prefix": "3ffe::/16",
"Label": 12
},
{
"Precedence": 30,
"Prefix": "2002::/16",
"Label": 2
},
{
"Precedence": 1,
"Prefix": "fec0::/10",
"Label": 11
},
{
"Precedence": 5,
"Prefix": "fc00::/7",
"Label": 5
},
{
"Precedence": 40,
"Prefix": "::/0",
"Label": 1
}
],
"SpeedMbps": 100,
"HostName": "",
"IPv6Addresses": [
{
"AddressState": "Preferred",
"Address": "fe80::7ed3:aff:feed:bb1a",
"PrefixLength": 64,
"AddressOrigin": "LinkLocal"
}
],
"FullDuplex": true,
"StaticNameServers": [
"0.0.0.0",
"0.0.0.0",
"0.0.0.0",
"::",
"::",
"::"
],
"DHCPv4": {
"UseDNSServers": false,
"FallbackAddress": "None",
"UseGateway": null,
"UseNTPServers": null,
"UseDomainName": false,
"DHCPEnabled": false,
"UseStaticRoutes": null
},
"IPv4Addresses": [
{
"Gateway": "0.0.0.0",
"Address": "169.254.95.118",
"SubnetMask": "255.255.0.0",
"AddressOrigin": "Static"
}
],
"Description": "Management Network Interface",
"StatelessAddressAutoConfig": {
"IPv4AutoConfigEnabled": null,
"IPv6AutoConfigEnabled": false
},
"IPv6StaticDefaultGateways": [
{
"PrefixLength": 0,
"Address": "::"
}
],
"MTUSize": 1500,
"DHCPv6": {
"OperatingMode": "Disabled",
"UseNTPServers": null,
"UseDomainName": false,
"UseRapidCommit": null,
"UseDNSServers": false
},
"Status": {
"State": "Enabled",
"Health": null
},
"MACAddress": "7c:d3:0a:ed:bb:1a",
"Name": "Manager Ethernet Over USB Interface",
"IPv4StaticAddresses": [
{
"Gateway": "0.0.0.0",
"Address": "169.254.95.119",
"SubnetMask": "255.255.0.0",
"AddressOrigin": "Static"
}
],
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/ToHost",
"Oem": {
"Lenovo": {
"OSIPv4Address": "169.254.95.120",
"AddressMode": "IPv6LLA",
"@odata.type": "#LenovoEthernetInterface.v1_0_0.LenovoEthernetInterfaceProperties",
"PortForwarding": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/ToHost/Oem/Lenovo/PortForwarding"
}
}
},
"@odata.type": "#EthernetInterface.v1_5_1.EthernetInterface",
"MaxIPv6StaticAddresses": 0,
"LinkStatus": "LinkUp",
"@odata.etag": "\"f57f676204ef32c8c907e\"",
"PermanentMACAddress": "7c:d3:0a:ed:bb:1a",
"NameServers": []
}