Host Nvdimm System Get Nvdimm System Info

Host NVDIMM information.

- Summary of all dimms on the host. - Array of all DIMMs on the host. - Array of DIMM information and health for all dimms on the host. - Array of interleave set for all sets on the host. - Array of interleave set information for all sets on the host. - Array of namespace IDs for all dimms on the host. - Array of namespace details of all dimms on the host.

Required privileges: Host.Config.Nvdimm

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/HostNvdimmSystem/{moId}/nvdimmSystemInfo

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostNvdimmSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Return set of all NVDIMM related information.

Returns NvdimmSystemInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "summary": {
        "numDimms": 0,
        "healthStatus": "string",
        "totalCapacity": 0,
        "persistentCapacity": 0,
        "blockCapacity": 0,
        "availableCapacity": 0,
        "numInterleavesets": 0,
        "numNamespaces": 0
    },
    "dimms": [
        0
    ],
    "dimmInfo": [
        {
            "_typeName": "string",
            "dimmHandle": 0,
            "healthInfo": {
                "healthStatus": "string",
                "healthInformation": "string",
                "stateFlagInfo": [
                    "string"
                ],
                "dimmTemperature": 0,
                "dimmTemperatureThreshold": 0,
                "spareBlocksPercentage": 0,
                "spareBlockThreshold": 0,
                "dimmLifespanPercentage": 0,
                "esTemperature": 0,
                "esTemperatureThreshold": 0,
                "esLifespanPercentage": 0
            },
            "totalCapacity": 0,
            "persistentCapacity": 0,
            "availablePersistentCapacity": 0,
            "volatileCapacity": 0,
            "availableVolatileCapacity": 0,
            "blockCapacity": 0,
            "regionInfo": [
                {
                    "_typeName": "string",
                    "regionId": 0,
                    "setId": 0,
                    "rangeType": "string",
                    "startAddr": 0,
                    "size": 0,
                    "offset": 0
                }
            ],
            "representationString": "string"
        }
    ],
    "interleaveSet": [
        0
    ],
    "iSetInfo": [
        {
            "_typeName": "string",
            "setId": 0,
            "rangeType": "string",
            "baseAddress": 0,
            "size": 0,
            "availableSize": 0,
            "deviceList": [
                0
            ],
            "state": "string"
        }
    ],
    "namespace": [
        {
            "_typeName": "string",
            "uuid": "string"
        }
    ],
    "nsInfo": [
        {
            "_typeName": "string",
            "uuid": "string",
            "friendlyName": "string",
            "blockSize": 0,
            "blockCount": 0,
            "type": "string",
            "namespaceHealthStatus": "string",
            "locationID": 0,
            "state": "string"
        }
    ],
    "nsDetails": [
        {
            "_typeName": "string",
            "uuid": "string",
            "friendlyName": "string",
            "size": 0,
            "type": "string",
            "namespaceHealthStatus": "string",
            "interleavesetID": 0,
            "state": "string"
        }
    ]
}

NvdimmSummary

summary

Optional

\brief Get summary of nvdimm

array of integer

dimms

Optional

List of NVDIMMs on the host.

NVDIMM list unset if the system does not support PMem feature.

array of NvdimmDimmInfo

dimmInfo

Optional