openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/cluster/DasConfigInfo/VmMonitoringState.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
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
2014-06-17 14:07:42 -04:00

2.6 KiB
Raw Blame History

vim.cluster.DasConfigInfo.VmMonitoringState

The ClusterDasConfigInfoVmMonitoringState enum defines values that indicate the state of Virtual Machine Health Monitoring. Health Monitoring uses the vmTools (guest) and application agent heartbeat modules. You can configure HA to respond to heartbeat failures of either one or both modules. You can also disable the HA response to heartbeat failures.
  • To set the cluster default for health monitoring, use the ClusterConfigSpecEx.dasConfig.
  • vmMonitoring
  • property.
  • To set health monitoring for a virtual machine, use the ClusterConfigSpecEx.dasVmConfigSpec.info.dasSettings.
  • vmToolsMonitoringSettings
  • property.
  • To retrieve the current state of health monitoring (cluster setting), use the ClusterConfigInfoEx.dasConfig.
  • vmMonitoring
  • property.
  • To retrieve the current state of health monitoring for a virtual machine, use the ClusterConfigInfoEx.dasVmConfig[].dasSettings.vmToolsMonitoringSettings.
  • vmMonitoring
  • property.
contained by

vim.cluster.DasConfigInfo

type

vim.cluster.DasConfigInfo.VmMonitoringState

name

vmAndAppMonitoring

values:

vmMonitoringDisabled

Virtual machine health monitoring is disabled. In this state, HA response to guest and application heartbeat failures are disabled.

vmMonitoringOnly

HA response to guest heartbeat failure is enabled. To retrieve the guest heartbeat status, use the VirtualMachine . guestHeartbeatStatus property.

vmAndAppMonitoring
HA response to both guest and application heartbeat failure is enabled.