Restoring Factory Settings

Function

This interface is used to restore factory settings remotely.

Syntax

Operation type: POST

URL: https://device_ip/redfish/v1/Systems/Actions/RestoreDefaults.Reset

Request header:

X-Auth-Token: auth_value
Content-Type: header_type

Request message body:

{
    "ethernet": ethernet,
    "root_pwd": password
}

Request Parameters

**Table 1** Parameters
Parameter	Mandatory/Optional	Description	Value
ethernet	Mandatory	Name of a network port device.	The value is a string (for example, eth0:1) of 0 to 32 characters, including lowercase letters (a to z), digits (0 to 9), and colons (:). The value cannot start with a colon (:). If the value is empty, the IP address is not reserved when factory settings are restored.
root_pwd	Mandatory	Password of the root user.	Password of the root user of the current system.

Usage Guidelines

This API is developed by default, but its functions have not been fully implemented. Therefore, restore the factory settings.

Example

Request:

POST https://10.10.10.10/redfish/v1/Systems/RestoreDefaults/Reset

Request header:

X-Auth-Token: auth_value
Content-Type: application/json

Request message body:

{
    "ethernet": "eth0",
    "root_pwd": "password"
}

Response:

{
    "error": {
        "code": "Base.1.0.Success",
        "message": "Operation success. See ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
                "Description": "Indicates that no error has occurred.",
                "Message": "Restore defaults system successfully.",
                "Severity": "OK",
                "NumberOfArgs": null,
                "ParamTypes": null,
                "Resolution": "None"
            }
        ]
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
code	Character string	A string indicating the specific message ID in the message registry.
message	Character string	Message details.
@odata.type	Character string	Session resource type.
Description	Character string	Details.
Message	Character string	Response message.
Severity	Character string	Severity supported by Redfish. OK Warning Critical
NumberOfArgs	Number	Number of added parameters.
ParamTypes	Array	Types of the added parameters.
Resolution	Character string	Solution description.

Parent topic: Software Management