Update Virtual Machine Classes
Update the configuration of the VM class object
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}
Path Parameters
Path Parameters
string
vm_class
Required
Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementVirtualMachineClassesUpdateSpec of mimetype application/json
Required
Information about the VM class object to be updated.
{
"cpu_count": 0,
"cpu_reservation": 0,
"description": "string",
"devices": {
"dynamic_direct_path_IO_devices": [
{
"custom_label": "string",
"device_id": 0,
"vendor_id": 0
}
],
"vgpu_devices": [
{
"profile_name": "string"
}
]
},
"instance_storage": {
"policy": "string",
"volumes": [
{
"size": 0
}
]
},
"memory_MB": 0,
"memory_reservation": 0
}
integer
cpu_count
Optional
The number of CPUs configured for virtual machine of this class. If unset the current value the will not be modified.
integer
cpu_reservation
Optional
The percentage of total available CPUs reserved for a virtual machine. We multiply this percentage by the minimum frequency amongst all the cluster nodes to get the CPU reservation that is specified to vSphere in MHz. If unset, no CPU reservation is requested for the virtual machine.
string
description
Optional
Description for the VM class. If unset, description is not updated.
devices
Optional
Virtual devices corresponding to the VM class. If unset, virtual devices will not be updated.
instance_storage
Optional
Instance storage associated with the VM class. If unset, instance storage specification will not be updated.
integer
memory_MB
Optional
The amount of memory in MB configured for virtual machine of this class. If unset the current value the will not be modified.
integer
memory_reservation
Optional
The percentage of available memory reserved for a virtual machine of this class. Memory reservation must be set to 100% for VM class with vGPU or Dynamic DirectPath I/O devices. If unset, no memory reservation is requested for virtual machine.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if a VM class by the name as specified in the spec already exists in the vCenter inventory. | com.vmware.vapi.std.errors.invalid_argument : if the input {@param.spec.instanceStorage.policy} refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have VirtualMachineClasses.Manage privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementVirtualMachineClassesVGPUDevice = Initialize-NamespaceManagementVirtualMachineClassesVGPUDevice -ProfileName "MyProfileName"
$NamespaceManagementVirtualMachineClassesDynamicDirectPathIODevice = Initialize-NamespaceManagementVirtualMachineClassesDynamicDirectPathIODevice -VendorId 0 -DeviceId 0 -CustomLabel "MyCustomLabel"
$NamespaceManagementVirtualMachineClassesVirtualDevices = Initialize-NamespaceManagementVirtualMachineClassesVirtualDevices -VgpuDevices $NamespaceManagementVirtualMachineClassesVGPUDevice -DynamicDirectPathIODevices $NamespaceManagementVirtualMachineClassesDynamicDirectPathIODevice
$NamespaceManagementVirtualMachineClassesInstanceStorageVolume = Initialize-NamespaceManagementVirtualMachineClassesInstanceStorageVolume -Size 0
$NamespaceManagementVirtualMachineClassesInstanceStorage = Initialize-NamespaceManagementVirtualMachineClassesInstanceStorage -Policy "MyPolicy" -Volumes $NamespaceManagementVirtualMachineClassesInstanceStorageVolume
$NamespaceManagementVirtualMachineClassesUpdateSpec = Initialize-NamespaceManagementVirtualMachineClassesUpdateSpec -CpuCount 0 -CpuReservation 0 -MemoryMB 0 -MemoryReservation 0 -Description "MyDescription" -Devices $NamespaceManagementVirtualMachineClassesVirtualDevices -InstanceStorage $NamespaceManagementVirtualMachineClassesInstanceStorage
Invoke-UpdateVmClassNamespaceManagementVirtualMachineClasses -VmClass "MyVmClass" -NamespaceManagementVirtualMachineClassesUpdateSpec $NamespaceManagementVirtualMachineClassesUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cpu_count":0,"cpu_reservation":0,"description":"string","devices":{"dynamic_direct_path_IO_devices":[{"custom_label":"string","device_id":0,"vendor_id":0}],"vgpu_devices":[{"profile_name":"string"}]},"instance_storage":{"policy":"string","volumes":[{"size":0}]},"memory_MB":0,"memory_reservation":0}' https://{api_host}/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
Availability
Added in 7.0.2.00100
