Customization Spec Manager Overwrite Customization Spec

Overwrites an existing specification, possibly after retrieving (by using 'get') and editing it.

If, based on the item's changeVersion value, the overwrite process detects that the specification has changed since its retrieval, then the API uses the SpecModified exception to warn clients that they might overwrite another client's change.

Required privileges: VirtualMachine.Provisioning.ModifyCustSpecs

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/CustomizationSpecManager/{moId}/OverwriteCustomizationSpec

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

string

release

Required

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

Request Body

OverwriteCustomizationSpecRequestType of type(s) application/json

Required

Show optional properties

{
    "item": {
        "info": {
            "name": "string",
            "description": "string",
            "type": "string"
        },
        "spec": {
            "identity": {},
            "globalIPSettings": {}
        }
    }
}

{
    "item": {
        "_typeName": "string",
        "info": {
            "_typeName": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "changeVersion": "string",
            "lastUpdateTime": "string"
        },
        "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
            ]
        }
    }
}

CustomizationSpecItem

item

Required

Specification information and the Specification object.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

NotFound:

ConcurrentAccess:

CannotDecryptPasswords:

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

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Customization Spec Manager Check Customization Resources