openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/cluster/VmHostRuleInfo.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.1 KiB
Raw Permalink Blame History

vim.cluster.VmHostRuleInfo

A ClusterVmHostRuleInfo object identifies virtual machines and host groups that determine virtual machine placement. The virtual machines and hosts referenced by a VM-Host rule must be in the same cluster.A VM-Host rule identifies the following groups.
  • A virtual machine group (
  • ClusterVmGroup
  • ).
  • Two host groups - an affine host group and an anti-affine host group (
  • ClusterHostGroup
  • ). At least one of the groups must contain one or more hosts.
  • ClusterVmHostRuleInfo
  • stores only the names of the relevant virtual machine and host groups. The group contents are stored in the virtual machine and host group objects.
  • When you modify a VM-Host rule, only the fields that are specified are set.
extends

vim.cluster.RuleInfo

since

vSphere API 4.1

Attributes:

vmGroupName (str, optional):

Virtual group name ( ClusterVmGroup . name ). The virtual group may contain one or more virtual machines.

affineHostGroupName (str, optional):

Name of the affine host group ( ClusterHostGroup . name ). The affine host group identifies hosts on which vmGroupName virtual machines can be powered-on. The value of the mandatory property determines how the Server interprets the rule.

antiAffineHostGroupName (str, optional):

Name of the anti-affine host group ( ClusterHostGroup . name ). The anti-affine host group identifies hosts on which vmGroupName virtual machines should not be powered-on. The value of the mandatory property determines how the Server interprets the rule.