Host Storage System Compute Disk Partition Info

Computes the disk partition information given the desired disk layout.

The server computes a new partition information object for a specific disk representing the desired layout.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostStorageSystem/{moId}/ComputeDiskPartitionInfo

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Request Body

ComputeDiskPartitionInfoRequestType of type(s) application/json

Required

{
    "devicePath": "string",
    "layout": {
        "total": {
            "blockSize": 0,
            "block": 0
        },
        "partition": [
            {
                "_typeName": "string",
                "partition": 0,
                "type": "string",
                "start": {
                    "blockSize": 0,
                    "block": 0
                },
                "end": {
                    "blockSize": 0,
                    "block": 0
                }
            }
        ]
    },
    "partitionFormat": "string"
}

string

devicePath

Required

The name of the device path for the specific disk.

HostDiskPartitionLayout

layout

Required

This data object type describes the disk partition layout specified as a list of ordered BlockRanges.

This view of the disk partitions shows the data on the disk as a contiguous set of BlockRanges.

string

partitionFormat

Optional

Specifies the desired partition format to be computed from the block range. If partitionFormat is not specified, the existing partitionFormat on disk is used, if the disk is not blank and mbr otherwise.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A data object that contains information about the partitions on a disk

Returns HostDiskPartitionInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "deviceName": "string",
    "spec": {
        "partitionFormat": "string",
        "chs": {
            "cylinder": 0,
            "head": 0,
            "sector": 0
        },
        "totalSectors": 0,
        "partition": [
            {
                "_typeName": "string",
                "partition": 0,
                "startSector": 0,
                "endSector": 0,
                "type": "string",
                "guid": "string",
                "logical": false,
                "attributes": 0,
                "partitionAlignment": 0
            }
        ]
    },
    "layout": {
        "total": {
            "blockSize": 0,
            "block": 0
        },
        "partition": [
            {
                "_typeName": "string",
                "partition": 0,
                "type": "string",
                "start": {
                    "blockSize": 0,
                    "block": 0
                },
                "end": {
                    "blockSize": 0,
                    "block": 0
                }
            }
        ]
    }
}

string

deviceName

Required

The device name of the disk to which this partition information corresponds.

HostDiskPartitionSpec

spec

Required

This data object type describes the disk partition table specification used to configure the partitions on a disk.

This data object represents the fundamental data needed to specify a partition table.

HostDiskPartitionLayout

layout

Required

This data object type describes the disk partition layout specified as a list of ordered BlockRanges.

This view of the disk partitions shows the data on the disk as a contiguous set of BlockRanges.

500

NotFound: if the device could not be found.

InvalidArgument: if the layout is invalid.

HostConfigFault: if unable to get the current partition information for the device.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Host Storage System Operations