Skip to main content

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, NIC2}

Request body

Properties to be updated are shown below:
FieldTypeDescription

InterfaceEnabled

Boolean

A boolean indicating whether this interface is enabled.

MACAddress

String

The currently configured MAC address of the (logical port) interface.

MTUSize

Number

The currently configured Maximum Transmission Unit (MTU) in bytes on this XCC3 interface.

HostName

String

The host name for this XCC3 interface, without any domain information.

IPv4StaticAddresses

Array

An array of objects used to represent the IPv4 connection characteristics for this XCC3 interface.

 

IPv4StaticAddress[0]

Object

Array element

  

Address

String

The IPv4 Address

  

Gateway

String

The IPv4 gateway for this address

  

SubnetMask

String

The IPv4 Subnet mask.

IPv6StaticAddresses

Array

An array of objects used to represent the IPv6 connection characteristics for this XCC3 interface

 

IPv6StaticAddresses[0]

Object

Array element

  

Address

String

The IPv6 Address

  

PrefixLength

Number

The IPv6 Address Prefix Length

IPv6StaticDefaultGateways

Array

An array of objects used to represent the IPv6 static default gateway for this XCC3 interface.

 

IPv6StaticDefaultGateways[0]

Object

Expanded.

  

Address

String

A valid IPv6 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.

 

VLANId

Number

The Id of VLAN.

 

VLANEnable

Boolean

The property of VLAN is Enable or not.

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.

DHCPv6

Object

Expanded.

 

OperatingMode

String

The operating mode is “Enabled” or “Disabled”.

 

UseDNSServers

Boolean

Use DNS servers or not.

 

UseDomainName

Boolean

Use Domain Name or not.

StaticNameServers

Array

The string array allows 6 entries. The first three items are used for IPv4 DNS server and the last three item are used for IPv6 DNS servers.

Items: string

Items count: 6

AutoNeg

Boolean

Indicates if the speed and duplex are automatically negotiated and configured on this XCC3 interface:

  • True. Auto negotiation of speed and duplex is enabled.

  • False. Auto negotiation of speed and duplex is disabled.

SpeedMbps

String

The current speed in Mbps of this XCC3 interface (units: Mbit/s). This value is null when “AutoNeg” is true.

FullDuplex

Boolean

The duplex status of the Ethernet connection on this XCC3 interface. This value is null when “AutoNeg” is true.

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 CodeError Message ID
400PropertyValueNotInList, PropertyValueFormatError, PropertyValueTypeError, PropertyNotWritable
500InternalError