Vcenter NamespaceManagement VirtualMachineClasses get
Return information about a VM class.
This operation was added in vSphere API 7.0.2.00100.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
com.vmware.vcenter.namespace_management.VirtualMachineClassreferenced by the parameter vm_class requiresSystem.Read.
Identifier for the VM class.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.
Information about the specified VM class.
{
"id": "string",
"cpu_count": 0,
"cpu_reservation": 0,
"memory_mb": 0,
"memory_reservation": 0,
"description": "string",
"namespaces": [
"string"
],
"vms": [
"string"
],
"config_status": "string",
"messages": [
{
"severity": "string",
"details": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
],
"devices": {
"vgpu_devices": [
{
"profile_name": "string"
}
],
"dynamic_direct_path_io_devices": [
{
"vendor_id": 0,
"device_id": 0,
"custom_label": "string"
}
]
},
"instance_storage": {
"policy": "string",
"volumes": [
{
"size": 0
}
]
},
"config_spec": {}
}Identifier for the VM class.
This property was added in vSphere API 7.0.2.00100.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.
The number of CPUs configured for virtual machine of this class.
This property was added in vSphere API 7.0.2.00100.
This property is deprecated as of vSphere API 8.0.2.0.
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.
This property was added in vSphere API 7.0.2.00100.
If missing or null, no CPU reservation is requested for the virtual machine.
The amount of memory in MB configured for virtual machine of this class.
This property was added in vSphere API 7.0.2.00100.
This property is deprecated as of vSphere API 8.0.2.0.
The percentage of available memory reserved for a virtual machine of this class.
This property was added in vSphere API 7.0.2.00100.
If missing or null, no memory reservation is requested for virtual machine.
Description of the VM class.
This property was added in vSphere API 7.0.2.00100.
Set of Namespaces associated with this VM class.
This property was added in vSphere API 7.0.2.00100.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance.
Set of virtual machines deployed for VM class.
This property was added in vSphere API 7.0.2.00100.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: VirtualMachine.
Configstatus of VM class
For more information see: Vcenter NamespaceManagement VirtualMachineClasses ConfigStatus.
This property was added in vSphere API 7.0.2.00100.
Current set of messages associated with the object.
This property was added in vSphere API 7.0.2.00100.
This property is deprecated as of vSphere API 8.0.2.0.
Virtual devices corresponding to the VM class.
This property was added in vSphere API 7.0.3.0.
This property is optional because it was added in a newer version than its parent node.
Instance storage associated with the VM class.
This property was added in vSphere API 8.0.0.0.
If missing or null, no instance storage is present.
A VirtualMachineConfigSpec associated with the VM class.
This property was added in vSphere API 8.0.2.0.
If missing or null, a config spec is not used to configure this VM class.
if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have System.Read privilege.
"Vapi Std Errors Unauthorized Object"if VM class can not be found in the vCenter inventory.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}