VirtualDeviceConfigSpec

VirtualDeviceConfigSpec
VirtualDeviceConfigSpec

The VirtualDeviceSpec data object type encapsulates change specifications for an individual virtual device.

The virtual device being added or modified must be fully specified.

AllOf
This class requires all of the following:
JSON Example
{
    "_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"
}
operation
Optional

Type of operation being performed on the specified virtual device.

If no operation is specified, the spec. is ignored.

fileOperation
Optional

Type of operation being performed on the backing of the specified virtual device.

If no file operation is specified in the VirtualDeviceSpec, then any backing filenames in the VirtualDevice must refer to files that already exist. The "replace" and "delete" values for this property are only applicable to virtual disk backing files.

device
Required

Device specification, with all necessary properties set.

profile
Optional

Virtual Device Profile requirement.

Profiles are solution specifics. Storage Profile Based Management(SPBM) is a vSphere server extension. The API users who want to provision VMs using Storage Profiles, need to interact with SPBM service. This is an optional parameter and if user doesn't specify profile, the default behavior will apply.

backing
Optional

BackingInfo configuration options.

Each BackingSpec corresponds to a BackingInfo object. The member backing refers to the device.backing.

filterSpec
Optional

List of independent filters VirtualMachineIndependentFilterSpec to configure on the virtual device.

Since: vSphere API Release 7.0.2.1

string
changeMode
Optional

The change mode of the device.

The values of the mode will be one of VirtualDeviceConfigSpecChangeModeEnum enumerations. On unset, default to 'fail'.

Since: vSphere API Release 8.0.0.1