Resetting the System

Function

This interface is used to reset the system.

Syntax

Operation type: POST

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

Request header:

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

Request message body:

{
    "ResetType": value
}

Request Parameters

Table 1 Parameters

Parameter

Mandatory/Optional

Description

Value

ResetType

Mandatory

Reset type

String

GracefulRestart

NOTE:

If you reset the system when performing an upgrade, making the upgrade take effect, or resetting the system, the system fails to be reset.

Usage Guidelines

None

Example

Request:

POST https://10.10.10.10/redfish/v1/Systems/Actions/ComputerSystem.Reset

Request header:

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

Request message body:

{
    "ResetType":"GracefulRestart"
}

Output Description

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": "Restart system (GracefulRestart) successfully.",
                "Severity": "OK",
                "NumberOfArgs": null,
                "ParamTypes": null,
                "Resolution": "None"
            }
        ]
    }
}

Response code: 200

Table 2 Operation output description

Field

Type

Description

code

String

A string indicating the specific message ID in the message registry.

message

String

Message details.

@odata.type

String

Session resource type.

Description

String

Details.

Message

String

Response message.

Severity

String

Severity supported by Redfish.
  • OK
  • Warning
  • Critical

NumberOfArgs

Number

Number of added parameters.

ParamTypes

Array

Types of the added parameters.

Resolution

String

Solution description.