Unmounting a Partition

Function

This interface is used to unmount a drive partition.

Syntax

Operation type: PATCH

URL: https://device_ip/redfish/v1/Systems/Partitions/Unmount

Request header:

X-Auth-Token: auth_value

Request message body:

{
    "PartitionID": "partition id"
}

Request Parameters

Table 1 Request parameters

Parameter

Mandatory/Optional

Description

Value

PartitionID

Mandatory

ID of a partition resource.

The value can be obtained by querying the drive partition collection information. The value is a string of 1 to 128 characters, including uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), and underscores (_). The value cannot contain two consecutive periods (..).

Usage Guidelines

The API is developed by default. The function is adapted based on the external storage configuration.

Example

Request:

PATCH https://10.10.10.10/redfish/v1/Systems/Partitions/Unmount

Request header:

X-Auth-Token: auth_value
Request message body:
{
    "PartitionID": "mdisk0p11"
}
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": "Unmount partition [mdisk0p11] successfully.",
                "Severity": "OK",
                "NumberOfArgs": null,
                "ParamTypes": null,
                "Resolution": "None"
            }
        ]
    }
}

Response code: 202

Table 2 Operation output description

Field

Type

Description

code

String

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

message

String

A readable message corresponding to a message in the message registry.

@odata.type

String

OData description of a message resource.

Description

String

Detailed description of a message resource.

Message

String

Detailed information about a message resource.

Severity

String

Severity.

  • OK
  • Warning
  • Critical

NumberOfArgs

Number

Number of parameters in a message description.

ParamTypes

Array

Parameter type list.

Resolution

String

Event handling suggestions.