Cluster Compute Resource Place Vm

Cluster Compute Resource Place Vm

This method returns a PlacementResult object.

This API can be invoked to ask DRS for a set of recommendations for moving a virtual machine and its virtual disks into a cluster.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/PlaceVm
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 ClusterComputeResource/{moId}.

string
release
Required

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


Request Body
PlaceVmRequestType of type(s) application/json
Required
{
    "placementSpec": {
        "_typeName": "string",
        "priority": "string",
        "vm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "configSpec": {
            "_typeName": "string",
            "changeVersion": "string",
            "name": "string",
            "version": "string",
            "createDate": "string",
            "uuid": "string",
            "instanceUuid": "string",
            "npivNodeWorldWideName": [
                0
            ],
            "npivPortWorldWideName": [
                0
            ],
            "npivWorldWideNameType": "string",
            "npivDesiredNodeWwns": 0,
            "npivDesiredPortWwns": 0,
            "npivTemporaryDisabled": false,
            "npivOnNonRdmDisks": false,
            "npivWorldWideNameOp": "string",
            "locationId": "string",
            "guestId": "string",
            "alternateGuestName": "string",
            "annotation": "string",
            "files": {
                "_typeName": "string",
                "vmPathName": "string",
                "snapshotDirectory": "string",
                "suspendDirectory": "string",
                "logDirectory": "string",
                "ftMetadataDirectory": "string"
            },
            "tools": {
                "_typeName": "string",
                "toolsVersion": 0,
                "toolsInstallType": "string",
                "afterPowerOn": false,
                "afterResume": false,
                "beforeGuestStandby": false,
                "beforeGuestShutdown": false,
                "beforeGuestReboot": false,
                "toolsUpgradePolicy": "string",
                "pendingCustomization": "string",
                "customizationKeyId": {
                    "_typeName": "string",
                    "keyId": "string",
                    "providerId": {
                        "_typeName": "string",
                        "id": "string"
                    }
                },
                "syncTimeWithHostAllowed": false,
                "syncTimeWithHost": false,
                "lastInstallInfo": {
                    "_typeName": "string",
                    "counter": 0,
                    "fault": {
                        "_typeName": "string",
                        "faultCause": "MethodFault Object",
                        "faultMessage": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "arg": [
                                    {
                                        "_typeName": "string",
                                        "key": "string",
                                        "value": {
                                            "_typeName": "string"
                                        }
                                    }
                                ],
                                "message": "string"
                            }
                        ]
                    }
                }
            },
            "flags": {
                "_typeName": "string",
                "disableAcceleration": false,
                "enableLogging": false,
                "useToe": false,
                "runWithDebugInfo": false,
                "monitorType": "string",
                "htSharing": "string",
                "snapshotDisabled": false,
                "snapshotLocked": false,
                "diskUuidEnabled": false,
                "virtualMmuUsage": "string",
                "virtualExecUsage": "string",
                "snapshotPowerOffBehavior": "string",
                "recordReplayEnabled": false,
                "faultToleranceType": "string",
                "cbrcCacheEnabled": false,
                "vvtdEnabled": false,
                "vbsEnabled": false
            },
            "consolePreferences": {
                "_typeName": "string",
                "powerOnWhenOpened": false,
                "enterFullScreenOnPowerOn": false,
                "closeOnPowerOffOrSuspend": false
            },
            "powerOpInfo": {
                "_typeName": "string",
                "powerOffType": "string",
                "suspendType": "string",
                "resetType": "string",
                "defaultPowerOffType": "string",
                "defaultSuspendType": "string",
                "defaultResetType": "string",
                "standbyAction": "string"
            },
            "rebootPowerOff": false,
            "numCPUs": 0,
            "vcpuConfig": [
                {
                    "_typeName": "string",
                    "latencySensitivity": {
                        "_typeName": "string",
                        "level": "string",
                        "sensitivity": 0
                    }
                }
            ],
            "numCoresPerSocket": 0,
            "memoryMB": 0,
            "memoryHotAddEnabled": false,
            "cpuHotAddEnabled": false,
            "cpuHotRemoveEnabled": false,
            "virtualICH7MPresent": false,
            "virtualSMCPresent": false,
            "deviceChange": [
                {
                    "_typeName": "string",
                    "operation": "string",
                    "fileOperation": "string",
                    "device": {
                        "_typeName": "string",
                        "key": 0,
                        "deviceInfo": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string"
                        },
                        "backing": {
                            "_typeName": "string"
                        },
                        "connectable": {
                            "_typeName": "string",
                            "migrateConnect": "string",
                            "startConnected": false,
                            "allowGuestControl": false,
                            "connected": false,
                            "status": "string"
                        },
                        "slotInfo": {
                            "_typeName": "string"
                        },
                        "controllerKey": 0,
                        "unitNumber": 0,
                        "numaNode": 0,
                        "deviceGroupInfo": {
                            "_typeName": "string",
                            "groupInstanceKey": 0,
                            "sequenceId": 0
                        }
                    },
                    "profile": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "backing": {
                        "_typeName": "string",
                        "parent": "VirtualDeviceConfigSpecBackingSpec Object",
                        "crypto": {
                            "_typeName": "string"
                        }
                    },
                    "filterSpec": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "changeMode": "string"
                }
            ],
            "cpuAllocation": {
                "_typeName": "string",
                "reservation": 0,
                "expandableReservation": false,
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "overheadLimit": 0
            },
            "memoryAllocation": {
                "_typeName": "string",
                "reservation": 0,
                "expandableReservation": false,
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "overheadLimit": 0
            },
            "latencySensitivity": {
                "_typeName": "string",
                "level": "string",
                "sensitivity": 0
            },
            "cpuAffinity": {
                "_typeName": "string",
                "affinitySet": [
                    0
                ]
            },
            "memoryAffinity": {
                "_typeName": "string",
                "affinitySet": [
                    0
                ]
            },
            "networkShaper": {
                "_typeName": "string",
                "enabled": false,
                "peakBps": 0,
                "averageBps": 0,
                "burstSize": 0
            },
            "cpuFeatureMask": [
                {
                    "_typeName": "string",
                    "operation": "string",
                    "removeKey": {
                        "_typeName": "string"
                    },
                    "info": {
                        "_typeName": "string",
                        "level": 0,
                        "vendor": "string",
                        "eax": "string",
                        "ebx": "string",
                        "ecx": "string",
                        "edx": "string"
                    }
                }
            ],
            "extraConfig": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "swapPlacement": "string",
            "bootOptions": {
                "_typeName": "string",
                "bootDelay": 0,
                "enterBIOSSetup": false,
                "efiSecureBootEnabled": false,
                "bootRetryEnabled": false,
                "bootRetryDelay": 0,
                "bootOrder": [
                    {
                        "_typeName": "string"
                    }
                ],
                "networkBootProtocol": "string"
            },
            "vAppConfig": {
                "_typeName": "string",
                "product": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "removeKey": {
                            "_typeName": "string"
                        },
                        "info": {
                            "_typeName": "string",
                            "key": 0,
                            "classId": "string",
                            "instanceId": "string",
                            "name": "string",
                            "vendor": "string",
                            "version": "string",
                            "fullVersion": "string",
                            "vendorUrl": "string",
                            "productUrl": "string",
                            "appUrl": "string"
                        }
                    }
                ],
                "property": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "removeKey": {
                            "_typeName": "string"
                        },
                        "info": {
                            "_typeName": "string",
                            "key": 0,
                            "classId": "string",
                            "instanceId": "string",
                            "id": "string",
                            "category": "string",
                            "label": "string",
                            "type": "string",
                            "typeReference": "string",
                            "userConfigurable": false,
                            "defaultValue": "string",
                            "value": "string",
                            "description": "string"
                        }
                    }
                ],
                "ipAssignment": {
                    "_typeName": "string",
                    "supportedAllocationScheme": [
                        "string"
                    ],
                    "ipAllocationPolicy": "string",
                    "supportedIpProtocol": [
                        "string"
                    ],
                    "ipProtocol": "string"
                },
                "eula": [
                    "string"
                ],
                "ovfSection": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "removeKey": {
                            "_typeName": "string"
                        },
                        "info": {
                            "_typeName": "string",
                            "key": 0,
                            "namespace": "string",
                            "type": "string",
                            "atEnvelopeLevel": false,
                            "contents": "string"
                        }
                    }
                ],
                "ovfEnvironmentTransport": [
                    "string"
                ],
                "installBootRequired": false,
                "installBootStopDelay": 0
            },
            "ftInfo": {
                "_typeName": "string",
                "role": 0,
                "instanceUuids": [
                    "string"
                ],
                "configPaths": [
                    "string"
                ],
                "orphaned": false
            },
            "repConfig": {
                "_typeName": "string",
                "generation": 0,
                "vmReplicationId": "string",
                "destination": "string",
                "port": 0,
                "rpo": 0,
                "quiesceGuestEnabled": false,
                "paused": false,
                "oppUpdatesEnabled": false,
                "netCompressionEnabled": false,
                "netEncryptionEnabled": false,
                "encryptionDestination": "string",
                "encryptionPort": 0,
                "remoteCertificateThumbprint": "string",
                "dataSetsReplicationEnabled": false,
                "disk": [
                    {
                        "_typeName": "string",
                        "key": 0,
                        "diskReplicationId": "string"
                    }
                ]
            },
            "vAppConfigRemoved": false,
            "vAssertsEnabled": false,
            "changeTrackingEnabled": false,
            "firmware": "string",
            "maxMksConnections": 0,
            "guestAutoLockEnabled": false,
            "managedBy": {
                "_typeName": "string",
                "extensionKey": "string",
                "type": "string"
            },
            "memoryReservationLockedToMax": false,
            "nestedHVEnabled": false,
            "vPMCEnabled": false,
            "scheduledHardwareUpgradeInfo": {
                "_typeName": "string",
                "upgradePolicy": "string",
                "versionKey": "string",
                "scheduledHardwareUpgradeStatus": "string",
                "fault": {
                    "_typeName": "string",
                    "faultCause": "MethodFault Object",
                    "faultMessage": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "arg": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "value": {
                                        "_typeName": "string"
                                    }
                                }
                            ],
                            "message": "string"
                        }
                    ]
                }
            },
            "vmProfile": [
                {
                    "_typeName": "string"
                }
            ],
            "messageBusTunnelEnabled": false,
            "crypto": {
                "_typeName": "string"
            },
            "migrateEncryption": "string",
            "sgxInfo": {
                "_typeName": "string",
                "epcSize": 0,
                "flcMode": "string",
                "lePubKeyHash": "string",
                "requireAttestation": false
            },
            "ftEncryptionMode": "string",
            "guestMonitoringModeInfo": {
                "_typeName": "string",
                "gmmFile": "string",
                "gmmAppliance": "string"
            },
            "sevEnabled": false,
            "virtualNuma": {
                "_typeName": "string",
                "coresPerNumaNode": 0,
                "exposeVnumaOnCpuHotadd": false
            },
            "motherboardLayout": "string",
            "pmemFailoverEnabled": false,
            "vmxStatsCollectionEnabled": false,
            "vmOpNotificationToAppEnabled": false,
            "vmOpNotificationTimeout": 0,
            "deviceSwap": {
                "_typeName": "string",
                "lsiToPvscsi": {
                    "_typeName": "string",
                    "enabled": false,
                    "applicable": false,
                    "status": "string"
                }
            },
            "simultaneousThreads": 0,
            "pmem": {
                "_typeName": "string",
                "snapshotMode": "string"
            },
            "deviceGroups": {
                "_typeName": "string",
                "deviceGroup": [
                    {
                        "_typeName": "string",
                        "groupInstanceKey": 0,
                        "deviceInfo": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string"
                        }
                    }
                ]
            },
            "fixedPassthruHotPlugEnabled": false
        },
        "relocateSpec": {
            "_typeName": "string",
            "service": {
                "_typeName": "string",
                "instanceUuid": "string",
                "url": "string",
                "credential": {
                    "_typeName": "string"
                },
                "sslThumbprint": "string"
            },
            "folder": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "diskMoveType": "string",
            "pool": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "disk": [
                {
                    "_typeName": "string",
                    "diskId": 0,
                    "datastore": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "diskMoveType": "string",
                    "diskBackingInfo": {
                        "_typeName": "string"
                    },
                    "profile": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "backing": {
                        "_typeName": "string",
                        "parent": "VirtualMachineRelocateSpecDiskLocatorBackingSpec Object",
                        "crypto": {
                            "_typeName": "string"
                        }
                    },
                    "filterSpec": [
                        {
                            "_typeName": "string"
                        }
                    ]
                }
            ],
            "transform": "string",
            "deviceChange": [
                {
                    "_typeName": "string",
                    "operation": "string",
                    "fileOperation": "string",
                    "device": {
                        "_typeName": "string",
                        "key": 0,
                        "deviceInfo": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string"
                        },
                        "backing": {
                            "_typeName": "string"
                        },
                        "connectable": {
                            "_typeName": "string",
                            "migrateConnect": "string",
                            "startConnected": false,
                            "allowGuestControl": false,
                            "connected": false,
                            "status": "string"
                        },
                        "slotInfo": {
                            "_typeName": "string"
                        },
                        "controllerKey": 0,
                        "unitNumber": 0,
                        "numaNode": 0,
                        "deviceGroupInfo": {
                            "_typeName": "string",
                            "groupInstanceKey": 0,
                            "sequenceId": 0
                        }
                    },
                    "profile": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "backing": {
                        "_typeName": "string",
                        "parent": "VirtualDeviceConfigSpecBackingSpec Object",
                        "crypto": {
                            "_typeName": "string"
                        }
                    },
                    "filterSpec": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "changeMode": "string"
                }
            ],
            "profile": [
                {
                    "_typeName": "string"
                }
            ],
            "cryptoSpec": {
                "_typeName": "string"
            }
        },
        "hosts": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "datastores": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "storagePods": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "disallowPrerequisiteMoves": false,
        "rules": [
            {
                "_typeName": "string",
                "key": 0,
                "status": "string",
                "enabled": false,
                "name": "string",
                "mandatory": false,
                "userCreated": false,
                "inCompliance": false,
                "ruleUuid": "string"
            }
        ],
        "key": "string",
        "placementType": "string",
        "cloneSpec": {
            "_typeName": "string",
            "location": {
                "_typeName": "string",
                "service": {
                    "_typeName": "string",
                    "instanceUuid": "string",
                    "url": "string",
                    "credential": {
                        "_typeName": "string"
                    },
                    "sslThumbprint": "string"
                },
                "folder": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "datastore": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "diskMoveType": "string",
                "pool": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "host": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "disk": [
                    {
                        "_typeName": "string",
                        "diskId": 0,
                        "datastore": {
                            "_typeName": "string",
                            "type": "string",
                            "value": "string"
                        },
                        "diskMoveType": "string",
                        "diskBackingInfo": {
                            "_typeName": "string"
                        },
                        "profile": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "backing": {
                            "_typeName": "string",
                            "parent": "VirtualMachineRelocateSpecDiskLocatorBackingSpec Object",
                            "crypto": {
                                "_typeName": "string"
                            }
                        },
                        "filterSpec": [
                            {
                                "_typeName": "string"
                            }
                        ]
                    }
                ],
                "transform": "string",
                "deviceChange": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "fileOperation": "string",
                        "device": {
                            "_typeName": "string",
                            "key": 0,
                            "deviceInfo": {
                                "_typeName": "string",
                                "label": "string",
                                "summary": "string"
                            },
                            "backing": {
                                "_typeName": "string"
                            },
                            "connectable": {
                                "_typeName": "string",
                                "migrateConnect": "string",
                                "startConnected": false,
                                "allowGuestControl": false,
                                "connected": false,
                                "status": "string"
                            },
                            "slotInfo": {
                                "_typeName": "string"
                            },
                            "controllerKey": 0,
                            "unitNumber": 0,
                            "numaNode": 0,
                            "deviceGroupInfo": {
                                "_typeName": "string",
                                "groupInstanceKey": 0,
                                "sequenceId": 0
                            }
                        },
                        "profile": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "backing": {
                            "_typeName": "string",
                            "parent": "VirtualDeviceConfigSpecBackingSpec Object",
                            "crypto": {
                                "_typeName": "string"
                            }
                        },
                        "filterSpec": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "changeMode": "string"
                    }
                ],
                "profile": [
                    {
                        "_typeName": "string"
                    }
                ],
                "cryptoSpec": {
                    "_typeName": "string"
                }
            },
            "template": false,
            "config": {
                "_typeName": "string",
                "changeVersion": "string",
                "name": "string",
                "version": "string",
                "createDate": "string",
                "uuid": "string",
                "instanceUuid": "string",
                "npivNodeWorldWideName": [
                    0
                ],
                "npivPortWorldWideName": [
                    0
                ],
                "npivWorldWideNameType": "string",
                "npivDesiredNodeWwns": 0,
                "npivDesiredPortWwns": 0,
                "npivTemporaryDisabled": false,
                "npivOnNonRdmDisks": false,
                "npivWorldWideNameOp": "string",
                "locationId": "string",
                "guestId": "string",
                "alternateGuestName": "string",
                "annotation": "string",
                "files": {
                    "_typeName": "string",
                    "vmPathName": "string",
                    "snapshotDirectory": "string",
                    "suspendDirectory": "string",
                    "logDirectory": "string",
                    "ftMetadataDirectory": "string"
                },
                "tools": {
                    "_typeName": "string",
                    "toolsVersion": 0,
                    "toolsInstallType": "string",
                    "afterPowerOn": false,
                    "afterResume": false,
                    "beforeGuestStandby": false,
                    "beforeGuestShutdown": false,
                    "beforeGuestReboot": false,
                    "toolsUpgradePolicy": "string",
                    "pendingCustomization": "string",
                    "customizationKeyId": {
                        "_typeName": "string",
                        "keyId": "string",
                        "providerId": {
                            "_typeName": "string",
                            "id": "string"
                        }
                    },
                    "syncTimeWithHostAllowed": false,
                    "syncTimeWithHost": false,
                    "lastInstallInfo": {
                        "_typeName": "string",
                        "counter": 0,
                        "fault": {
                            "_typeName": "string",
                            "faultCause": "MethodFault Object",
                            "faultMessage": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "arg": [
                                        {
                                            "_typeName": "string",
                                            "key": "string",
                                            "value": {
                                                "_typeName": "string"
                                            }
                                        }
                                    ],
                                    "message": "string"
                                }
                            ]
                        }
                    }
                },
                "flags": {
                    "_typeName": "string",
                    "disableAcceleration": false,
                    "enableLogging": false,
                    "useToe": false,
                    "runWithDebugInfo": false,
                    "monitorType": "string",
                    "htSharing": "string",
                    "snapshotDisabled": false,
                    "snapshotLocked": false,
                    "diskUuidEnabled": false,
                    "virtualMmuUsage": "string",
                    "virtualExecUsage": "string",
                    "snapshotPowerOffBehavior": "string",
                    "recordReplayEnabled": false,
                    "faultToleranceType": "string",
                    "cbrcCacheEnabled": false,
                    "vvtdEnabled": false,
                    "vbsEnabled": false
                },
                "consolePreferences": {
                    "_typeName": "string",
                    "powerOnWhenOpened": false,
                    "enterFullScreenOnPowerOn": false,
                    "closeOnPowerOffOrSuspend": false
                },
                "powerOpInfo": {
                    "_typeName": "string",
                    "powerOffType": "string",
                    "suspendType": "string",
                    "resetType": "string",
                    "defaultPowerOffType": "string",
                    "defaultSuspendType": "string",
                    "defaultResetType": "string",
                    "standbyAction": "string"
                },
                "rebootPowerOff": false,
                "numCPUs": 0,
                "vcpuConfig": [
                    {
                        "_typeName": "string",
                        "latencySensitivity": {
                            "_typeName": "string",
                            "level": "string",
                            "sensitivity": 0
                        }
                    }
                ],
                "numCoresPerSocket": 0,
                "memoryMB": 0,
                "memoryHotAddEnabled": false,
                "cpuHotAddEnabled": false,
                "cpuHotRemoveEnabled": false,
                "virtualICH7MPresent": false,
                "virtualSMCPresent": false,
                "deviceChange": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "fileOperation": "string",
                        "device": {
                            "_typeName": "string",
                            "key": 0,
                            "deviceInfo": {
                                "_typeName": "string",
                                "label": "string",
                                "summary": "string"
                            },
                            "backing": {
                                "_typeName": "string"
                            },
                            "connectable": {
                                "_typeName": "string",
                                "migrateConnect": "string",
                                "startConnected": false,
                                "allowGuestControl": false,
                                "connected": false,
                                "status": "string"
                            },
                            "slotInfo": {
                                "_typeName": "string"
                            },
                            "controllerKey": 0,
                            "unitNumber": 0,
                            "numaNode": 0,
                            "deviceGroupInfo": {
                                "_typeName": "string",
                                "groupInstanceKey": 0,
                                "sequenceId": 0
                            }
                        },
                        "profile": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "backing": {
                            "_typeName": "string",
                            "parent": "VirtualDeviceConfigSpecBackingSpec Object",
                            "crypto": {
                                "_typeName": "string"
                            }
                        },
                        "filterSpec": [
                            {
                                "_typeName": "string"
                            }
                        ],
                        "changeMode": "string"
                    }
                ],
                "cpuAllocation": {
                    "_typeName": "string",
                    "reservation": 0,
                    "expandableReservation": false,
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "overheadLimit": 0
                },
                "memoryAllocation": {
                    "_typeName": "string",
                    "reservation": 0,
                    "expandableReservation": false,
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "overheadLimit": 0
                },
                "latencySensitivity": {
                    "_typeName": "string",
                    "level": "string",
                    "sensitivity": 0
                },
                "cpuAffinity": {
                    "_typeName": "string",
                    "affinitySet": [
                        0
                    ]
                },
                "memoryAffinity": {
                    "_typeName": "string",
                    "affinitySet": [
                        0
                    ]
                },
                "networkShaper": {
                    "_typeName": "string",
                    "enabled": false,
                    "peakBps": 0,
                    "averageBps": 0,
                    "burstSize": 0
                },
                "cpuFeatureMask": [
                    {
                        "_typeName": "string",
                        "operation": "string",
                        "removeKey": {
                            "_typeName": "string"
                        },
                        "info": {
                            "_typeName": "string",
                            "level": 0,
                            "vendor": "string",
                            "eax": "string",
                            "ebx": "string",
                            "ecx": "string",
                            "edx": "string"
                        }
                    }
                ],
                "extraConfig": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "swapPlacement": "string",
                "bootOptions": {
                    "_typeName": "string",
                    "bootDelay": 0,
                    "enterBIOSSetup": false,
                    "efiSecureBootEnabled": false,
                    "bootRetryEnabled": false,
                    "bootRetryDelay": 0,
                    "bootOrder": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "networkBootProtocol": "string"
                },
                "vAppConfig": {
                    "_typeName": "string",
                    "product": [
                        {
                            "_typeName": "string",
                            "operation": "string",
                            "removeKey": {
                                "_typeName": "string"
                            },
                            "info": {
                                "_typeName": "string",
                                "key": 0,
                                "classId": "string",
                                "instanceId": "string",
                                "name": "string",
                                "vendor": "string",
                                "version": "string",
                                "fullVersion": "string",
                                "vendorUrl": "string",
                                "productUrl": "string",
                                "appUrl": "string"
                            }
                        }
                    ],
                    "property": [
                        {
                            "_typeName": "string",
                            "operation": "string",
                            "removeKey": {
                                "_typeName": "string"
                            },
                            "info": {
                                "_typeName": "string",
                                "key": 0,
                                "classId": "string",
                                "instanceId": "string",
                                "id": "string",
                                "category": "string",
                                "label": "string",
                                "type": "string",
                                "typeReference": "string",
                                "userConfigurable": false,
                                "defaultValue": "string",
                                "value": "string",
                                "description": "string"
                            }
                        }
                    ],
                    "ipAssignment": {
                        "_typeName": "string",
                        "supportedAllocationScheme": [
                            "string"
                        ],
                        "ipAllocationPolicy": "string",
                        "supportedIpProtocol": [
                            "string"
                        ],
                        "ipProtocol": "string"
                    },
                    "eula": [
                        "string"
                    ],
                    "ovfSection": [
                        {
                            "_typeName": "string",
                            "operation": "string",
                            "removeKey": {
                                "_typeName": "string"
                            },
                            "info": {
                                "_typeName": "string",
                                "key": 0,
                                "namespace": "string",
                                "type": "string",
                                "atEnvelopeLevel": false,
                                "contents": "string"
                            }
                        }
                    ],
                    "ovfEnvironmentTransport": [
                        "string"
                    ],
                    "installBootRequired": false,
                    "installBootStopDelay": 0
                },
                "ftInfo": {
                    "_typeName": "string",
                    "role": 0,
                    "instanceUuids": [
                        "string"
                    ],
                    "configPaths": [
                        "string"
                    ],
                    "orphaned": false
                },
                "repConfig": {
                    "_typeName": "string",
                    "generation": 0,
                    "vmReplicationId": "string",
                    "destination": "string",
                    "port": 0,
                    "rpo": 0,
                    "quiesceGuestEnabled": false,
                    "paused": false,
                    "oppUpdatesEnabled": false,
                    "netCompressionEnabled": false,
                    "netEncryptionEnabled": false,
                    "encryptionDestination": "string",
                    "encryptionPort": 0,
                    "remoteCertificateThumbprint": "string",
                    "dataSetsReplicationEnabled": false,
                    "disk": [
                        {
                            "_typeName": "string",
                            "key": 0,
                            "diskReplicationId": "string"
                        }
                    ]
                },
                "vAppConfigRemoved": false,
                "vAssertsEnabled": false,
                "changeTrackingEnabled": false,
                "firmware": "string",
                "maxMksConnections": 0,
                "guestAutoLockEnabled": false,
                "managedBy": {
                    "_typeName": "string",
                    "extensionKey": "string",
                    "type": "string"
                },
                "memoryReservationLockedToMax": false,
                "nestedHVEnabled": false,
                "vPMCEnabled": false,
                "scheduledHardwareUpgradeInfo": {
                    "_typeName": "string",
                    "upgradePolicy": "string",
                    "versionKey": "string",
                    "scheduledHardwareUpgradeStatus": "string",
                    "fault": {
                        "_typeName": "string",
                        "faultCause": "MethodFault Object",
                        "faultMessage": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "arg": [
                                    {
                                        "_typeName": "string",
                                        "key": "string",
                                        "value": {
                                            "_typeName": "string"
                                        }
                                    }
                                ],
                                "message": "string"
                            }
                        ]
                    }
                },
                "vmProfile": [
                    {
                        "_typeName": "string"
                    }
                ],
                "messageBusTunnelEnabled": false,
                "crypto": {
                    "_typeName": "string"
                },
                "migrateEncryption": "string",
                "sgxInfo": {
                    "_typeName": "string",
                    "epcSize": 0,
                    "flcMode": "string",
                    "lePubKeyHash": "string",
                    "requireAttestation": false
                },
                "ftEncryptionMode": "string",
                "guestMonitoringModeInfo": {
                    "_typeName": "string",
                    "gmmFile": "string",
                    "gmmAppliance": "string"
                },
                "sevEnabled": false,
                "virtualNuma": {
                    "_typeName": "string",
                    "coresPerNumaNode": 0,
                    "exposeVnumaOnCpuHotadd": false
                },
                "motherboardLayout": "string",
                "pmemFailoverEnabled": false,
                "vmxStatsCollectionEnabled": false,
                "vmOpNotificationToAppEnabled": false,
                "vmOpNotificationTimeout": 0,
                "deviceSwap": {
                    "_typeName": "string",
                    "lsiToPvscsi": {
                        "_typeName": "string",
                        "enabled": false,
                        "applicable": false,
                        "status": "string"
                    }
                },
                "simultaneousThreads": 0,
                "pmem": {
                    "_typeName": "string",
                    "snapshotMode": "string"
                },
                "deviceGroups": {
                    "_typeName": "string",
                    "deviceGroup": [
                        {
                            "_typeName": "string",
                            "groupInstanceKey": 0,
                            "deviceInfo": {
                                "_typeName": "string",
                                "label": "string",
                                "summary": "string"
                            }
                        }
                    ]
                },
                "fixedPassthruHotPlugEnabled": false
            },
            "customization": {
                "_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
                ]
            },
            "powerOn": false,
            "snapshot": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "memory": false,
            "tpmProvisionPolicy": "string"
        },
        "cloneName": "string"
    }
}
placementSpec
Required

PlacementSpec encapsulates all of the information passed to the PlaceVm method, which asks DRS for recommendations for target hosts and datastores for placing a virtual machine and its virtual disks in a cluster using unified VMotion.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PlacementResult of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "recommendations": [
        {
            "_typeName": "string",
            "key": "string",
            "type": "string",
            "time": "string",
            "rating": 0,
            "reason": "string",
            "reasonText": "string",
            "warningText": "string",
            "warningDetails": {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            },
            "prerequisite": [
                "string"
            ],
            "action": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "target": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    }
                }
            ],
            "target": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "drsFault": {
        "_typeName": "string",
        "reason": "string",
        "faultsByVm": [
            {
                "_typeName": "string",
                "vm": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "fault": [
                    {
                        "_typeName": "string",
                        "faultCause": "MethodFault Object",
                        "faultMessage": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "arg": [
                                    {
                                        "_typeName": "string",
                                        "key": "string",
                                        "value": {
                                            "_typeName": "string"
                                        }
                                    }
                                ],
                                "message": "string"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
recommendations
Optional

The list of recommendations for where to place the virtual machine and its virtual disks.

drsFault
Optional

The faults generated by DRS when it tries to make recommendations for rule enforcement, power management, etc., and indexed in a tree structure with reason for recommendations and VM to migrate (optional) as the index keys.


500

InvalidState: if invoked on a DRS disabled cluster.

InvalidArgument: in case of errors in the input "placementSpec". The API can be used for either intra-vCenter migration or cross-vCenter migration, with different requirements for the PlacementSpec. For intra-vCenter migration, the requirements for PlacementSpec are:

  • PlacementSpec.vm is required.
  • PlacementSpec.relocateSpec can be used to optionally specify the target host, target datastore, or target resource pool for the migration.
  • PlacementSpec.hosts can be used to optionally specify a list of compatible hosts for the incoming virtual machine. If this list is empty, all hosts in the cluster will be considered for placement.
  • PlacementSpec.datastores can be used to optionally specify a list of compatible datastores for the incoming virtual machine. If this list is empty, all datastores connected to the hosts in the cluster will be considered for placement.
  • PlacementSpec.storagePods can be used to optionally specify a list of compatible datastore clusters for the incoming virtual machine. If this list is empty, all datastores connected to the hosts in the cluster will be considered for placement. For cross-vCenter migration, the requirements for PlacementSpec are:
  • PlacementSpec.configSpec is required. Within the ConfigSpec, the following elements are required if PlacementSpec.relocateSpec.host is empty: version, cpuAllocation, memoryAllocation, numCPUs, memoryMB; additionally, the following elements of the ConfigSpec are required if PlacementSpec.relocateSpec.datastore is empty: files, swapPlacement, deviceChange.
  • PlacementSpec.relocateSpec can be used to optionally specify the target host, target datastore, or target resource pool for the migration.
  • PlacementSpec.hosts is required, if PlacementSpec.relocateSpec.host is empty; otherwise, the selected hosts in the PlacementResult are not guaranteed to be compatible with the incoming virtual machine.
  • PlacementSpec.datastores is required, if PlacementSpec.relocateSpec.datastore is empty; otherwise, the selected datastores in the PlacementResult are not guaranteed to be compatible with the incoming virtual machine.
Returns InvalidState 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"
        }
    ]
}

Cluster Compute Resource Operations
POST
Cluster Compute Resource Abandon Hci Workflow
POST
Cluster Compute Resource Add Host Task
POST
Cluster Compute Resource Apply Recommendation
POST
Cluster Compute Resource Cancel Recommendation
POST
Cluster Compute Resource Cluster Enter Maintenance Mode
POST
Cluster Compute Resource Configure HCI Task
POST
Cluster Compute Resource Destroy Task
POST
Cluster Compute Resource Evc Manager
POST
Cluster Compute Resource Extend HCI Task
POST
Cluster Compute Resource Find Rules For Vm
GET
Cluster Compute Resource Get Action History
GET
Cluster Compute Resource Get Alarm Actions Enabled
GET
Cluster Compute Resource Get Available Field
GET
Cluster Compute Resource Get Config Issue
GET
Cluster Compute Resource Get Config Manager Enabled
GET
Cluster Compute Resource Get Config Status
GET
Cluster Compute Resource Get Configuration
GET
Cluster Compute Resource Get Configuration Ex
GET
Cluster Compute Resource Get Custom Value
GET
Cluster Compute Resource Get Datastore
GET
Cluster Compute Resource Get Declared Alarm State
GET
Cluster Compute Resource Get Disabled Method
GET
Cluster Compute Resource Get Drs Fault
GET
Cluster Compute Resource Get Drs Recommendation
GET
Cluster Compute Resource Get Effective Role
GET
Cluster Compute Resource Get Environment Browser
GET
Cluster Compute Resource Get Hci Config
GET
Cluster Compute Resource Get Host
GET
Cluster Compute Resource Get Lifecycle Managed
GET
Cluster Compute Resource Get Migration History
GET
Cluster Compute Resource Get Name
GET
Cluster Compute Resource Get Network
GET
Cluster Compute Resource Get Overall Status
GET
Cluster Compute Resource Get Parent
GET
Cluster Compute Resource Get Permission
GET
Cluster Compute Resource Get Recent Task
GET
Cluster Compute Resource Get Recommendation
GET
Cluster Compute Resource Get Resource Pool
POST
Cluster Compute Resource Get Resource Usage
GET
Cluster Compute Resource Get Summary
GET
Cluster Compute Resource Get Summary Ex
POST
Cluster Compute Resource Get System V Ms Restricted Datastores
GET
Cluster Compute Resource Get Tag
GET
Cluster Compute Resource Get Triggered Alarm State
GET
Cluster Compute Resource Get Value
POST
Cluster Compute Resource Move Host Into Task
POST
Cluster Compute Resource Move Into Task
POST
Cluster Compute Resource Place Vm
POST
Cluster Compute Resource Recommend Hosts For Vm
POST
Cluster Compute Resource Reconfigure Cluster Task
POST
Cluster Compute Resource Reconfigure Compute Resource Task
POST
Cluster Compute Resource Refresh Recommendation
POST
Cluster Compute Resource Reload
POST
Cluster Compute Resource Rename Task
POST
Cluster Compute Resource Retrieve Das Advanced Runtime Info
POST
Cluster Compute Resource Set Crypto Mode
POST
Cluster Compute Resource Set Custom Value
POST
Cluster Compute Resource Stamp All Rules With Uuid Task
POST
Cluster Compute Resource Validate HCI Configuration