Virtual Machine Check Customization Spec

Checks the customization specification against the virtual machine configuration.

For example, this is used on a source virtual machine before a clone operation to catch customization failure before the disk copy. This checks the specification's internal consistency as well as for compatibility with this virtual machine's configuration.

Required privileges: VirtualMachine.Provisioning.Customize

Request

URI

POST

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

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 VirtualMachine/{moId}.

string

release

Required

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

Request Body

CheckCustomizationSpecRequestType of type(s) application/json

Required

{
    "spec": {
        "_typeName": "string",
        "options": {
            "_typeName": "string"
        },
        "identity": {
            "_typeName": "string"
        },
        "globalIPSettings": {
            "_typeName": "string",
            "dnsSuffixList": [
                "string"
            ],
            "dnsServerList": [
                "string"
            ]
        },
        "nicSettingMap": [
            {
                "_typeName": "string",
                "macAddress": "string",
                "adapter": {
                    "_typeName": "string",
                    "ip": {
                        "_typeName": "string"
                    },
                    "subnetMask": "string",
                    "gateway": [
                        "string"
                    ],
                    "ipV6Spec": {
                        "_typeName": "string",
                        "ip": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "gateway": [
                            "string"
                        ]
                    },
                    "dnsServerList": [
                        "string"
                    ],
                    "dnsDomain": "string",
                    "primaryWINS": "string",
                    "secondaryWINS": "string",
                    "netBIOS": "string"
                }
            }
        ],
        "encryptionKey": [
            0
        ]
    }
}

CustomizationSpec

spec

Required

The Specification data object type contains information required to customize a virtual machine when deploying it or migrating it to a new host.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

CustomizationFault: A subclass of CustomizationFault is thrown.

Returns CustomizationFault of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_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

204 Response Body

Errors

Virtual Machine Operations