Skip to main content

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.

FieldTypeError Message ID

InterfaceEnabled

BooleanIndicate whether this interface is enabled.

CredentialBootstrapping

ObjectExpanded
 

Enabled

Boolean

When value is false, IPMI command 2C 01 and 2C 02 shall be rejected with Completion code 0x80.

When there is an existing boot strap account, this value shall be always “disabled”.

 

EnableAfterReset

BooleanIf the value is true, after XCC/host reboot, the property “Enabled” will be changed to true automatically, as the boot strap account is expired and deleted.

Response body​

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

Status code​

HTTP Status CodeError Message ID
500InternalError

Response example​

The following example is PATCH body.

{
   "InterfaceEnabled" : true,
   "CredentialBootstrapping": {
        "Enabled": true,
        "EnableAfterReset": false
    }
}

After the PATCH operation runs successfully, querying the host interface resource returns below example JSON response:

{
    "ExternallyAccessible": false,
    "NetworkProtocol": {
        "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
    },
    "HostInterfaceType": "NetworkHostInterface",
    "Description": "This resource shall be used to represent Host Interface resources as part of the Redfish specification.",
    "Id": "1",
    "Name": "Host Interface",
    "@odata.type": "#HostInterface.v1_3_0.HostInterface",
    "@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1",
    "ManagerEthernetInterface": {
        "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/ToHost"
    },
    "@odata.context": "/redfish/v1/$metadata#HostInterface.HostInterface",
    "@odata.etag": "\"621e8062feb328ae395\"",
    "HostEthernetInterfaces": {
        "@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1/HostEthernetInterfaces"
    },
    "CredentialBootstrapping": {
        "Enabled": true,
        "RoleId": "Administrator",
        "EnableAfterReset": false
    },
    "InterfaceEnabled": true,
    "Links": {
        "ComputerSystems": [
            {
                "@odata.id": "/redfish/v1/Systems/1"
            }
        ]
    }
}