Virtual Machine Get Layout Ex

Detailed information about the files that comprise this virtual machine.

Can be explicitly refreshed by the RefreshStorageInfo operation. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/layoutEx

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 VirtualMachine/{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

Returns VirtualMachineFileLayoutEx of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "file": [
        {
            "_typeName": "string",
            "key": 0,
            "name": "string",
            "type": "string",
            "size": 0,
            "uniqueSize": 0,
            "backingObjectId": "string",
            "accessible": false
        }
    ],
    "disk": [
        {
            "_typeName": "string",
            "key": 0,
            "chain": [
                {
                    "_typeName": "string",
                    "fileKey": [
                        0
                    ]
                }
            ]
        }
    ],
    "snapshot": [
        {
            "_typeName": "string",
            "key": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "dataKey": 0,
            "memoryKey": 0,
            "disk": [
                {
                    "_typeName": "string",
                    "key": 0,
                    "chain": [
                        {
                            "_typeName": "string",
                            "fileKey": [
                                0
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "timestamp": "string"
}

array of VirtualMachineFileLayoutExFileInfo

file

Optional

Information about all the files that constitute the virtual machine including configuration files, disks, swap file, suspend file, log files, core files, memory file etc.

VirtualMachineFileLayoutExFileTypeEnum lists the different file-types that make a virtual machine.

array of VirtualMachineFileLayoutExDiskLayout

disk

Optional

Layout of each virtual disk attached to the virtual machine.

For a virtual machine with snaphots, this property gives only those disks that are attached to it at the current point of running.

array of VirtualMachineFileLayoutExSnapshotLayout

snapshot

Optional

Layout of each snapshot of the virtual machine.

string As date-time As date-time

timestamp