ConfigTarget

ConfigTarget
ConfigTarget

The ConfigTarget class contains information about "physical" devices that can be used to back virtual devices.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "numCpus": 0,
    "numCpuCores": 0,
    "numNumaNodes": 0,
    "maxCpusPerHost": 0,
    "smcPresent": false,
    "datastore": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "datastore": {
                "_typeName": "string",
                "datastore": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "name": "string",
                "url": "string",
                "capacity": 0,
                "freeSpace": 0,
                "uncommitted": 0,
                "accessible": false,
                "multipleHostAccess": false,
                "type": "string",
                "maintenanceMode": "string"
            },
            "capability": {
                "_typeName": "string",
                "directoryHierarchySupported": false,
                "rawDiskMappingsSupported": false,
                "perFileThinProvisioningSupported": false,
                "storageIORMSupported": false,
                "nativeSnapshotSupported": false,
                "topLevelDirectoryCreateSupported": false,
                "seSparseSupported": false,
                "vmfsSparseSupported": false,
                "vsanSparseSupported": false,
                "upitSupported": false,
                "vmdkExpandSupported": false,
                "clusteredVmdkSupported": false
            },
            "maxFileSize": 0,
            "maxVirtualDiskCapacity": 0,
            "maxPhysicalRDMFileSize": 0,
            "maxVirtualRDMFileSize": 0,
            "mode": "string",
            "vStorageSupport": "string"
        }
    ],
    "network": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "network": {
                "_typeName": "string",
                "network": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "name": "string",
                "accessible": false,
                "ipPoolName": "string",
                "ipPoolId": 0
            },
            "vswitch": "string"
        }
    ],
    "opaqueNetwork": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "network": {
                "_typeName": "string",
                "network": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "name": "string",
                "accessible": false,
                "ipPoolName": "string",
                "ipPoolId": 0,
                "opaqueNetworkId": "string",
                "opaqueNetworkType": "string"
            },
            "networkReservationSupported": false
        }
    ],
    "distributedVirtualPortgroup": [
        {
            "_typeName": "string",
            "switchName": "string",
            "switchUuid": "string",
            "portgroupName": "string",
            "portgroupKey": "string",
            "portgroupType": "string",
            "uplinkPortgroup": false,
            "portgroup": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "networkReservationSupported": false,
            "backingType": "string",
            "logicalSwitchUuid": "string",
            "segmentId": "string"
        }
    ],
    "distributedVirtualSwitch": [
        {
            "_typeName": "string",
            "switchName": "string",
            "switchUuid": "string",
            "distributedVirtualSwitch": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "networkReservationSupported": false
        }
    ],
    "cdRom": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "description": "string"
        }
    ],
    "serial": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ]
        }
    ],
    "parallel": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ]
        }
    ],
    "sound": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ]
        }
    ],
    "usb": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "description": "string",
            "vendor": 0,
            "product": 0,
            "physicalPath": "string",
            "family": [
                "string"
            ],
            "speed": [
                "string"
            ],
            "summary": {
                "_typeName": "string",
                "vm": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "runtime": {
                    "_typeName": "string",
                    "device": [
                        {
                            "_typeName": "string",
                            "runtimeState": {
                                "_typeName": "string"
                            },
                            "key": 0
                        }
                    ],
                    "host": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "connectionState": "string",
                    "powerState": "string",
                    "vmFailoverInProgress": false,
                    "faultToleranceState": "string",
                    "dasVmProtection": {
                        "_typeName": "string",
                        "dasProtected": false
                    },
                    "toolsInstallerMounted": false,
                    "suspendTime": "string",
                    "bootTime": "string",
                    "suspendInterval": 0,
                    "question": {
                        "_typeName": "string",
                        "id": "string",
                        "text": "string",
                        "choice": {
                            "_typeName": "string",
                            "valueIsReadonly": false,
                            "choiceInfo": [
                                {
                                    "_typeName": "string",
                                    "label": "string",
                                    "summary": "string",
                                    "key": "string"
                                }
                            ],
                            "defaultIndex": 0
                        },
                        "message": [
                            {
                                "_typeName": "string",
                                "id": "string",
                                "argument": [
                                    {
                                        "_typeName": "string"
                                    }
                                ],
                                "text": "string"
                            }
                        ]
                    },
                    "memoryOverhead": 0,
                    "maxCpuUsage": 0,
                    "maxMemoryUsage": 0,
                    "numMksConnections": 0,
                    "recordReplayState": "string",
                    "cleanPowerOff": false,
                    "needSecondaryReason": "string",
                    "onlineStandby": false,
                    "minRequiredEVCModeKey": "string",
                    "consolidationNeeded": false,
                    "offlineFeatureRequirement": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "featureName": "string",
                            "value": "string"
                        }
                    ],
                    "featureRequirement": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "featureName": "string",
                            "value": "string"
                        }
                    ],
                    "featureMask": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "featureName": "string",
                            "value": "string"
                        }
                    ],
                    "vFlashCacheAllocation": 0,
                    "paused": false,
                    "snapshotInBackground": false,
                    "quiescedForkParent": false,
                    "instantCloneFrozen": false,
                    "cryptoState": "string",
                    "suspendedToMemory": false,
                    "opNotificationTimeout": 0,
                    "iommuActive": false
                },
                "guest": {
                    "_typeName": "string",
                    "guestId": "string",
                    "guestFullName": "string",
                    "toolsStatus": "string",
                    "toolsVersionStatus": "string",
                    "toolsVersionStatus2": "string",
                    "toolsRunningStatus": "string",
                    "hostName": "string",
                    "ipAddress": "string",
                    "hwVersion": "string"
                },
                "config": {
                    "_typeName": "string",
                    "name": "string",
                    "template": false,
                    "vmPathName": "string",
                    "memorySizeMB": 0,
                    "cpuReservation": 0,
                    "memoryReservation": 0,
                    "numCpu": 0,
                    "numEthernetCards": 0,
                    "numVirtualDisks": 0,
                    "uuid": "string",
                    "instanceUuid": "string",
                    "guestId": "string",
                    "guestFullName": "string",
                    "annotation": "string",
                    "product": {
                        "_typeName": "string",
                        "key": 0,
                        "classId": "string",
                        "instanceId": "string",
                        "name": "string",
                        "vendor": "string",
                        "version": "string",
                        "fullVersion": "string",
                        "vendorUrl": "string",
                        "productUrl": "string",
                        "appUrl": "string"
                    },
                    "installBootRequired": false,
                    "ftInfo": {
                        "_typeName": "string",
                        "role": 0,
                        "instanceUuids": [
                            "string"
                        ],
                        "configPaths": [
                            "string"
                        ],
                        "orphaned": false
                    },
                    "managedBy": {
                        "_typeName": "string",
                        "extensionKey": "string",
                        "type": "string"
                    },
                    "tpmPresent": false,
                    "numVmiopBackings": 0,
                    "hwVersion": "string"
                },
                "storage": {
                    "_typeName": "string",
                    "committed": 0,
                    "uncommitted": 0,
                    "unshared": 0,
                    "timestamp": "string"
                },
                "quickStats": {
                    "_typeName": "string",
                    "overallCpuUsage": 0,
                    "overallCpuDemand": 0,
                    "overallCpuReadiness": 0,
                    "guestMemoryUsage": 0,
                    "hostMemoryUsage": 0,
                    "guestHeartbeatStatus": "string",
                    "distributedCpuEntitlement": 0,
                    "distributedMemoryEntitlement": 0,
                    "staticCpuEntitlement": 0,
                    "staticMemoryEntitlement": 0,
                    "grantedMemory": 0,
                    "privateMemory": 0,
                    "sharedMemory": 0,
                    "swappedMemory": 0,
                    "balloonedMemory": 0,
                    "consumedOverheadMemory": 0,
                    "ftLogBandwidth": 0,
                    "ftSecondaryLatency": 0,
                    "ftLatencyStatus": "string",
                    "compressedMemory": 0,
                    "uptimeSeconds": 0,
                    "ssdSwappedMemory": 0,
                    "activeMemory": 0,
                    "memoryTierStats": [
                        {
                            "_typeName": "string",
                            "memoryTierType": "string",
                            "readBandwidth": 0
                        }
                    ]
                },
                "overallStatus": "string",
                "customValue": [
                    {
                        "_typeName": "string",
                        "key": 0
                    }
                ]
            }
        }
    ],
    "floppy": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ]
        }
    ],
    "legacyNetworkInfo": [
        {
            "_typeName": "string",
            "name": "string"
        }
    ],
    "scsiPassthrough": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "scsiClass": "string",
            "vendor": "string",
            "physicalUnitNumber": 0
        }
    ],
    "scsiDisk": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "capacity": 0,
            "vm": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            ],
            "disk": {
                "_typeName": "string",
                "deviceName": "string",
                "deviceType": "string",
                "key": "string",
                "uuid": "string",
                "descriptor": [
                    {
                        "_typeName": "string",
                        "quality": "string",
                        "id": "string"
                    }
                ],
                "canonicalName": "string",
                "displayName": "string",
                "lunType": "string",
                "vendor": "string",
                "model": "string",
                "revision": "string",
                "scsiLevel": 0,
                "serialNumber": "string",
                "durableName": {
                    "_typeName": "string",
                    "namespace": "string",
                    "namespaceId": 0,
                    "data": [
                        0
                    ]
                },
                "alternateName": [
                    {
                        "_typeName": "string",
                        "namespace": "string",
                        "namespaceId": 0,
                        "data": [
                            0
                        ]
                    }
                ],
                "standardInquiry": [
                    0
                ],
                "queueDepth": 0,
                "operationalState": [
                    "string"
                ],
                "capabilities": {
                    "_typeName": "string",
                    "updateDisplayNameSupported": false
                },
                "vStorageSupport": "string",
                "protocolEndpoint": false,
                "perenniallyReserved": false,
                "clusteredVmdkSupported": false,
                "applicationProtocol": "string",
                "dispersedNs": false,
                "deviceReservation": "string",
                "capacity": {
                    "_typeName": "string",
                    "blockSize": 0,
                    "block": 0
                },
                "devicePath": "string",
                "ssd": false,
                "localDisk": false,
                "physicalLocation": [
                    "string"
                ],
                "emulatedDIXDIFEnabled": false,
                "vsanDiskInfo": {
                    "_typeName": "string",
                    "vsanUuid": "string",
                    "formatVersion": 0
                },
                "scsiDiskType": "string",
                "usedByMemoryTiering": false
            },
            "transportHint": "string",
            "lunNumber": 0
        }
    ],
    "ideDisk": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "capacity": 0,
            "vm": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            ],
            "partitionTable": [
                {
                    "_typeName": "string",
                    "id": 0,
                    "capacity": 0
                }
            ]
        }
    ],
    "maxMemMBOptimalPerf": 0,
    "supportedMaxMemMB": 0,
    "resourcePool": {
        "_typeName": "string",
        "memory": {
            "_typeName": "string",
            "reservationUsed": 0,
            "reservationUsedForVm": 0,
            "unreservedForPool": 0,
            "unreservedForVm": 0,
            "overallUsage": 0,
            "maxUsage": 0
        },
        "cpu": {
            "_typeName": "string",
            "reservationUsed": 0,
            "reservationUsedForVm": 0,
            "unreservedForPool": 0,
            "unreservedForVm": 0,
            "overallUsage": 0,
            "maxUsage": 0
        },
        "overallStatus": "string",
        "sharesScalable": "string"
    },
    "autoVmotion": false,
    "pciPassthrough": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "pciDevice": {
                "_typeName": "string",
                "id": "string",
                "classId": 0,
                "bus": 0,
                "slot": 0,
                "function": 0,
                "vendorId": 0,
                "subVendorId": 0,
                "vendorName": "string",
                "deviceId": 0,
                "subDeviceId": 0,
                "parentBridge": "string",
                "deviceName": "string",
                "deviceClassName": "string"
            },
            "systemId": "string"
        }
    ],
    "sriov": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "pciDevice": {
                "_typeName": "string",
                "id": "string",
                "classId": 0,
                "bus": 0,
                "slot": 0,
                "function": 0,
                "vendorId": 0,
                "subVendorId": 0,
                "vendorName": "string",
                "deviceId": 0,
                "subDeviceId": 0,
                "parentBridge": "string",
                "deviceName": "string",
                "deviceClassName": "string"
            },
            "systemId": "string",
            "virtualFunction": false,
            "pnic": "string",
            "devicePool": {
                "_typeName": "string",
                "key": "string"
            }
        }
    ],
    "vFlashModule": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "vFlashModule": {
                "_typeName": "string",
                "vFlashModule": "string",
                "vFlashModuleVersion": "string",
                "minSupportedModuleVersion": "string",
                "cacheConsistencyType": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "choiceInfo": [
                        {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        }
                    ],
                    "defaultIndex": 0
                },
                "cacheMode": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "choiceInfo": [
                        {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string"
                        }
                    ],
                    "defaultIndex": 0
                },
                "blockSizeInKBOption": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "min": 0,
                    "max": 0,
                    "defaultValue": 0
                },
                "reservationInMBOption": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "min": 0,
                    "max": 0,
                    "defaultValue": 0
                },
                "maxDiskSizeInKB": 0
            }
        }
    ],
    "sharedGpuPassthroughTypes": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "vgpu": "string"
        }
    ],
    "availablePersistentMemoryReservationMB": 0,
    "dynamicPassthrough": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "vendorName": "string",
            "deviceName": "string",
            "customLabel": "string",
            "vendorId": 0,
            "deviceId": 0
        }
    ],
    "sgxTargetInfo": {
        "_typeName": "string",
        "name": "string",
        "configurationTag": [
            "string"
        ],
        "maxEpcSize": 0,
        "flcModes": [
            "string"
        ],
        "lePubKeyHashes": [
            "string"
        ],
        "requireAttestationSupported": false
    },
    "precisionClockInfo": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "systemClockProtocol": "string"
        }
    ],
    "sevSupported": false,
    "vgpuDeviceInfo": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "deviceName": "string",
            "deviceVendorId": 0,
            "maxFbSizeInGib": 0,
            "timeSlicedCapable": false,
            "migCapable": false,
            "computeProfileCapable": false,
            "quadroProfileCapable": false
        }
    ],
    "vgpuProfileInfo": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "profileName": "string",
            "deviceVendorId": 0,
            "fbSizeInGib": 0,
            "profileSharing": "string",
            "profileClass": "string",
            "stunTimeEstimates": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "configurationTag": [
                        "string"
                    ],
                    "migrationBW": 0,
                    "stunTime": 0
                }
            ]
        }
    ],
    "vendorDeviceGroupInfo": [
        {
            "_typeName": "string",
            "name": "string",
            "configurationTag": [
                "string"
            ],
            "deviceGroupName": "string",
            "deviceGroupDescription": "string",
            "componentDeviceInfo": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "vendorName": "string",
                    "deviceName": "string",
                    "isConfigurable": false,
                    "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
                        }
                    }
                }
            ]
        }
    ],
    "maxSimultaneousThreads": 0,
    "dvxClassInfo": [
        {
            "_typeName": "string",
            "deviceClass": {
                "_typeName": "string",
                "label": "string",
                "summary": "string",
                "key": "string"
            },
            "vendorName": "string",
            "sriovNic": false,
            "configParams": [
                {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "optionType": {
                        "_typeName": "string",
                        "valueIsReadonly": false
                    }
                }
            ]
        }
    ]
}
integer As int32 As int32
numCpus
Required

Number of logical CPUs that can be used to run virtual machines.

If invoked against a cluster, this is the total number of logical CPUs available in the cluster.

integer As int32 As int32
numCpuCores
Required

Number of physical CPU cores that are available to run virtual machines.

If invoked against a cluster, this is the total number of physical CPUs available in the cluster.

integer As int32 As int32
numNumaNodes
Required

Number of NUMA nodes.

If invoked against a cluster, this is the total number of NUMA nodes available in the cluster.

integer As int32 As int32
maxCpusPerHost
Optional

Maximum number of CPUs available on a single host.

For standalone hosts, this value will be the same as numCpus.

boolean
smcPresent
Required

Presence of System Management Controller, indicates the host is Apple hardware, and thus capable of running Mac OS guest as VM.

datastore
Optional

List of datastores available for virtual disks and associated storage.

network
Optional

List of networks available for virtual network adapters.

opaqueNetwork
Optional

List of opaque networks available for virtual network adapters.

distributedVirtualPortgroup
Optional

List of networks available from DistributedVirtualSwitch for virtual network adapters.

distributedVirtualSwitch
Optional

List of distributed virtual switch available for virtual network adapters.

cdRom
Optional

List of CD-ROM devices available for use by virtual CD-ROMs.

Used for VirtualCdromAtapiBackingInfo.

serial
Optional

List of serial devices available to support virtualization.

Used for VirtualSerialPortDeviceBackingInfo.

parallel
Optional

List of parallel devices available to support virtualization.

Used for VirtualParallelPortDeviceBackingInfo.

sound
Optional

List of sound devices available to support virtualization.

Used for VirtualSoundCardDeviceBackingInfo.

usb
Optional

List of USB devices on the host that are available to support virtualization.

Used for VirtualUSBUSBBackingInfo.

floppy
Optional

List of floppy devices available for use by virtual floppies.

Used for VirtualFloppyDeviceBackingInfo.

legacyNetworkInfo
Optional

Legacy switch names when using the LegacyNetworkBacking types.

scsiPassthrough
Optional

List of generic SCSI devices.

scsiDisk
Optional

List of physical SCSI disks that can be used as targets for raw disk mapping backings.

ideDisk
Optional

List of physical IDE disks that can be used as targets for raw disk backings.

integer As int32 As int32
maxMemMBOptimalPerf
Required

Maximum recommended memory size, in MB, for creating a new virtual machine.

integer As int32 As int32
supportedMaxMemMB
Optional

Maximum supported memory size, in MB, for creating a new virtual machine.

Maximum allowed size is smaller of this and limit in GuestOsDescriptor.supportedMaxMemMB. When invoked on the cluster, maximum size that can be created on at least one host in the cluster is reported.

resourcePool
Optional

Current runtime resource usage and state of the resource pool

boolean
autoVmotion
Optional

Information whether a virtual machine with this ConfigTarget can auto vmotion.

This field is only populated from an Environment browser obtained from a virtual machine.

pciPassthrough
Optional

List of generic PCI devices.

sriov
Optional

List of SRIOV devices.

vFlashModule
Optional

List of vFlash modules.

sharedGpuPassthroughTypes
Optional

List of shared GPU passthrough types.

integer As int64 As int64
availablePersistentMemoryReservationMB
Optional

Maximum available persistent memory reservation on a compute resource in MB.

dynamicPassthrough
Optional

List of Dynamic DirectPath PCI devices.

sgxTargetInfo
Optional

Description of Intel Software Guard Extensions information.

precisionClockInfo
Optional

List of host clock resources available to support virtual precision clock device.

Used for VirtualPrecisionClockSystemClockBackingInfo

boolean
sevSupported
Optional

Indicates whether the compute resource is capable of running AMD Secure Encrypted Virtualization (SEV) enabled virtual machines.

The compute resource supports SEV when this value is set to true.

Since: vSphere API Release 7.0.1.0

vgpuDeviceInfo
Optional

List of vGPU device capabilities.

Since: vSphere API Release 7.0.3.0

vgpuProfileInfo
Optional

List of vGPU profile attributes.

Since: vSphere API Release 7.0.3.0

vendorDeviceGroupInfo
Optional

List of PCI Vendor Device Groups.

Since: vSphere API Release 8.0.0.1

integer As int32 As int32
maxSimultaneousThreads
Optional

Max SMT (Simultaneous multithreading) threads.

Since: vSphere API Release 8.0.0.1

dvxClassInfo
Optional

List of Device Virtualization Extensions (DVX) classes.

Since: vSphere API Release 8.0.0.1