List Virtual Machine Classes
Return information about all VirtualMachine classes.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementVirtualMachineClassesInfo
of type application/json
List of information about all VirtualMachine classes
[
{
"config_status": "READY",
"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,
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "INFO"
}
],
"namespaces": [
"string"
],
"vms": [
"string"
]
}
]
config_status
Required
ConfigStatus represents the config status of the VM class.
READY : Indicates that the instance of the VirtualMachineClasses is ready to be used.
REMOVING : Indicates that the instance of the VirtualMachineClasses is being deleted. At this state the VM class cannot be associated with new Namespace.
Possible values are: READY , REMOVING
integer
cpu_count
Required
The number of CPUs configured for virtual machine of this class.
string
description
Required
Description of the VM class.
array of
string
namespaces
Required
Set of Namespaces associated with this VM class. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance.
string
id
Required
Identifier for the VM class. 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.
messages
Required
Current set of messages associated with the object.
array of
string
vms
Required
Set of virtual machines deployed for VM class. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: VirtualMachine.
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.
instance_storage
Optional
Instance storage associated with the VM class. If unset, no instance storage is present.
integer
memory_reservation
Optional
The percentage of available memory reserved for a virtual machine of this class. If unset, no memory reservation is requested for virtual machine.
devices
Optional
Virtual devices corresponding to the VM class. This field is optional because it was added in a newer version than its parent node.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read 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
Invoke-ListNamespaceManagementVirtualMachineClasses
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" 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: list
Availability
Added in 7.0.2.00100
