PATCH – Enable/disable host interface
Use the PATCH method to update properties in Host Interface resource for Redfish service.
Request URL
PATCH https://<BMC_IPADDR>/redfish/v1/Managers/1/HostInterfaces/1
Request body
Property to be updated is shown as bellow.
Field | Type | Error Message ID |
---|---|---|
InterfaceEnabled | Boolean | Indicate whether this interface is enabled. |
Response body
The response returns same content as GET operation with updated properties.
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Response example
The following example is PATCH body.
{
"InterfaceEnabled" : false
}
After the PATCH operation runs successfully, querying the host interface resource returns below example JSON response:
{
"HostInterfaceType": "NetworkHostInterface",
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
},
"Id": "1",
"InterfaceEnabled": false,
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
]
},
"Name": "Host Interface",
"@odata.context": "/redfish/v1/$metadata#HostInterface.HostInterface",
"@odata.etag": "\"3d8fd8e9aa9e2d0aa76f0ac687eecbbd\"",
"@odata.type": "#HostInterface.v1_2_0.HostInterface",
"ManagerEthernetInterface": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/ToHost"
},
"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1",
"ExternallyAccessible": false,
"HostEthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1/HostEthernetInterfaces"
},
"Description": "This resource shall be used to represent Host Interface resources as part of the Redfish specification."
}
Give documentation feedback