15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
74 lines
2.0 KiB
ReStructuredText
74 lines
2.0 KiB
ReStructuredText
.. _config: ../../vim/host/CpuSchedulerSystem/HyperThreadScheduleInfo.rst#config
|
|
|
|
.. _vim.Task: ../../vim/Task.rst
|
|
|
|
.. _vmodl.fault.NotSupported: ../../vmodl/fault/NotSupported.rst
|
|
|
|
.. _vim.ExtensibleManagedObject: ../../vim/ExtensibleManagedObject.rst
|
|
|
|
.. _vim.host.CpuSchedulerSystem.HyperThreadScheduleInfo: ../../vim/host/CpuSchedulerSystem/HyperThreadScheduleInfo.rst
|
|
|
|
|
|
vim.host.CpuSchedulerSystem
|
|
===========================
|
|
This managed object provides an interface through which you can gather and configure the host CPU scheduler policies that affect the performance of running virtual machines.Note: This managed object is useful only on platforms where resource management controls are available to optimize the running of virtual machines.
|
|
|
|
|
|
:extends: vim.ExtensibleManagedObject_
|
|
|
|
|
|
Attributes
|
|
----------
|
|
hyperthreadInfo (`vim.host.CpuSchedulerSystem.HyperThreadScheduleInfo`_):
|
|
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.
|
|
|
|
|
|
Methods
|
|
-------
|
|
|
|
|
|
EnableHyperThreading():
|
|
Treat hyperthreads as schedulable resources the next time the CPU scheduler starts. If successful, this operation will set the `config`_ property to "true".
|
|
|
|
|
|
Privilege:
|
|
Host.Config.HyperThreading
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vmodl.fault.NotSupported`_:
|
|
if the hyperthreading optimization is not available on the host (the boolean `available`_ is set to false).
|
|
|
|
|
|
DisableHyperThreading():
|
|
Don't treat hyperthreads as schedulable resources the next time the CPU scheduler starts. If successful, this operation will change the configured setting.
|
|
|
|
|
|
Privilege:
|
|
Host.Config.HyperThreading
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vmodl.fault.NotSupported`_:
|
|
if the hyperthreading optimization is not available on the host (the boolean `available`_ is set to false).
|
|
|
|
|