Querying NFS Partition Information

Function

This interface is used to query the NFS partition information configured.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/NfsManage

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/NfsManage

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/NfsManage",
    "@odata.type": "#MindXEdgeNfsManage.v1_0_0.MindXEdgeNfsManage",
    "@odata.id": "/redfish/v1/Systems/NfsManage",
    "Id": "1",
    "Name": "Nfs Manage",
    "nfsList": [{
        "ServerIP": "xx.xx.xx.xx",
        "ServerDir": "/home/huawei/nfstest",
        "MountPath": "/home/test2",
        "FileSystem": "nfs4",
        "Status": "ok",
        "CapacityBytes": 585995649024,
        "FreeBytes": 497078501376
    },
    {
        "ServerIP": "xx.xx.xx.xx",
        "ServerDir": "/home",
        "MountPath": "/home/test3",
        "FileSystem": "nfs4",
        "Status": "error",
        "CapacityBytes": "NA",
        "FreeBytes": "NA"
    }]
    "Actions": {
        "#NfsManage.Mount": {
            "target": "/redfish/v1/Systems/NfsManage/Actions/NfsManage.Mount"
        },
        "#NfsManage.Unmount": {
            "target": "/redfish/v1/Systems/NfsManage/Actions/NfsManage.Unmount"
        }
    }
}

Response code: 200

Output Description

Table 1 Operation output description

Field

Type

Description

@odata.context

Character string

OData description of the NFS partition information.

@odata.type

Character string

Type of the NFS partition information.

@odata.id

Character string

Path to access the NFS partition information.

Id

Character string

ID of the NFS partition information.

Name

Character string

Name of the NFS partition information.

nfsList

Array

NFS partition information list.

ServerIP

Character string

IP address of an NFS server.

ServerDir

Character string

Shared directory on an NFS server.

MountPath

Character string

Local directory to which an NFS partition is mounted.

FileSystem

Character string

NFS version information.

Status

Character string

Health status of an NFS partition.

CapacityBytes

Number

Total capacity of NFS partitions.

FreeBytes

Number

Remaining free space of NFS partitions.

Actions

Object

Operation that can be performed on NFS resources.

#NfsManage.Mount

Object

Mounts NFS resources.

target

Character string

Access path for mounting NFS resources.

#NfsManage.Unmount

Object

Unmounts NFS resources.

target

Character string

Access path for unmounting NFS resources.