Host Cpu Scheduler System Get Hyperthread Info

Host Cpu Scheduler System Get Hyperthread Info

The hyperthread configuration for the CpuSchedulerSystem.

The existence of this data object type indicates if the CPU scheduler is capable of scheduling hyperthreads as resources.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostCpuSchedulerSystem/{moId}/hyperthreadInfo
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostCpuSchedulerSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostHyperThreadScheduleInfo of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "available": false,
    "active": false,
    "config": false
}
boolean
available
Required

The flag to indicate whether or not hyperthreading optimization is available on the system.

This property is set by VMware prior to installation.

boolean
active
Required

The flag to indicate whether or not the CPU scheduler is currently treating hyperthreads as schedulable resources.

Setting this property involves a successful invocation of either the enableHyperThreading() method ("true") or the disableHyperthreading() method ("false"). The property is set once the system is rebooted.

boolean
config
Required

The flag to indicate whether or not the CPU scheduler should treat hyperthreads as schedulable resources the next time the CPU scheduler starts.

  • This property is set to "true" by successfully invoking the enableHyperThreading() method.
  • This property is set to "false" by successfully invoking the disableHyperthreading() method.

On This Page
Virtual Infrastructure Operations
POST
Host Cpu Scheduler System Disable Hyper Threading
POST
Host Cpu Scheduler System Enable Hyper Threading
GET
Host Cpu Scheduler System Get Available Field
GET
Host Cpu Scheduler System Get Cpu Scheduler Info
GET
Host Cpu Scheduler System Get Hyperthread Info
GET
Host Cpu Scheduler System Get Value
POST
Host Cpu Scheduler System Set Custom Value