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"
}
VirtualDeviceConfigSpecOperation_enum
operation
Optional

The type of operation being performed on the specified virtual device.

Valid values are:

Possible values:

  • add: Specifies the addition of a virtual device to the configuration.
  • remove: Specifies the removal of a virtual device.
  • edit: Specifies changes to the virtual device specification.
Possible values are : add, remove, edit,
VirtualDeviceConfigSpecFileOperation_enum
fileOperation
Optional

The type of operation being performed on the backing of a virtual device.

Valid values are:

Possible values:

  • create: Specifies the creation of the device backing; for example, the creation of a virtual disk or floppy image file.
  • destroy: Specifies the destruction of a device backing.
  • replace: Specifies the deletion of the existing backing for a virtual device and the creation of a new backing.
Possible values are : create, destroy, replace,
VirtualDevice
device
Required

VirtualDevice is the base data object type for devices in a virtual machine.

This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is.

array of VirtualMachineProfileSpec
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.

VirtualDeviceConfigSpecBackingSpec
backing
Optional

VirtualDeviceConfigSpecBackingSpec is a data object type for information about configuration of the backing of a device in a virtual machine.

The member parent refers the parent in the chain of VirtualDeviceBackingInfo objects.

array of VirtualMachineBaseIndependentFilterSpec
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

Property Of
Used By