Create Virtual Machine Classes
DescriptionCreate a VM class object.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/virtual-machine-classes
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
NamespaceManagementVirtualMachineClassesCreateSpec of mimetype application/json
Required
Information about the VM class object to be created.
{
"cpu_count": 0,
"id": "string",
"memory_MB": 0
}
integer
cpu_count
Required
The number of CPUs configured for virtual machine of this class.
string
id
Required
Identifier of the virtual machine class. This has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the ‘-’ character allowed anywhere except the first or last character. This name is unique in this vCenter server. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.
integer
memory_MB
Required
The amount of memory in MB configured for virtual machine of this class.
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, no description is added to the VM class.
devices
Optional
Virtual devices that will be attached to the VMs created with this class. If unset, no Virtual device will be attached to the VMs created with this class.
instance_storage
Optional
Instance storage that will be attached to the VMs created with this class. If unset, instance storage specification will not be created.
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
$NamespaceManagementVirtualMachineClassesCreateSpec = Initialize-NamespaceManagementVirtualMachineClassesCreateSpec -Id "MyId" -CpuCount 0 -MemoryMB 0
Invoke-CreateNamespaceManagementVirtualMachineClasses -NamespaceManagementVirtualMachineClassesCreateSpec $NamespaceManagementVirtualMachineClassesCreateSpec
PowerCLI Client SDK All Parameters 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
$NamespaceManagementVirtualMachineClassesCreateSpec = Initialize-NamespaceManagementVirtualMachineClassesCreateSpec -Id "MyId" -CpuCount 0 -CpuReservation 0 -MemoryMB 0 -MemoryReservation 0 -Description "MyDescription" -Devices $NamespaceManagementVirtualMachineClassesVirtualDevices -InstanceStorage $NamespaceManagementVirtualMachineClassesInstanceStorage
Invoke-CreateNamespaceManagementVirtualMachineClasses -NamespaceManagementVirtualMachineClassesCreateSpec $NamespaceManagementVirtualMachineClassesCreateSpec
cURL Command
curl -X POST -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"}]},"id":"string","instance_storage":{"policy":"string","volumes":[{"size":0}]},"memory_MB":0,"memory_reservation":0}' https://{api_host}/api/vcenter/namespace-management/virtual-machine-classes
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.2.00100
