<spanid="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-package"></span><h1>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package<aclass="headerlink"href="#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module<aclass="headerlink"href="#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_tag</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CreateSpec</span></code> class contains information used to create a new vMotion
policy that applies when a host is evacuated, see
<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create"title="com.vmware.vcenter.compute_client.Policies.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>, in VMware Cloud
on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual
machines that share the tag indicated by <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CreateSpec.vm_tag</span></code> will be
vMotioned from a host whenever the host is evacuated by vCenter. If vCenter
cannot migrate a virtual machine, then it will remain running on its
current host. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
Virtual machines with this tag will be vMotioned from a host if
vCenter requires to evacuate the host. If vMotion is not feasible,
then the virtual machine will remain running on its current host.
<strong>Warning:</strong> This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
a value of this class as a return value, the attribute will be an
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
server. <strong>Warning:</strong> This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">capability</span></code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_tag</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Info</span></code> class contains information about a vMotion policy that applies
when a host is evacuated, see
<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get"title="com.vmware.vcenter.compute_client.Policies.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>, in VMware Cloud on
AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual
machines that share the tag indicated by <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Info.vm_tag</span></code> will be
vMotioned from a host whenever the host is evacuated by vCenter. If vCenter
cannot migrate a virtual machine, then it will remain running on its
current host. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
Virtual machines with this tag will be vMotioned from a host if
vCenter requires to evacuate the host. If vMotion is not feasible,
then the virtual machine will remain running on its current host.
<strong>Warning:</strong> This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
a value of this class as a return value, the attribute will be an
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">capability</span></code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory"title="Permalink to this definition">¶</a></dt>
