1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 20:09:58 -05:00
vsphere-automation-sdk-python/vsphere/7.0.0.1/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html

420 lines
22 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package &mdash; vSphere Automation SDK for Python. 7.0.0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.content package" href="com.vmware.vcenter.content.html" />
<link rel="prev" title="com.vmware.vcenter.compute.policies.capabilities.vm package" href="com.vmware.vcenter.compute.policies.capabilities.vm.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.compute.policies.capabilities.vm.html">com.vmware.vcenter.compute.policies.capabilities.vm package</a> &raquo;</li>
<li>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation">
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-package"></span><h1>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-evacuation-vmotion-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client</span></code>
module provides classes for the virtual machine evacuation vMotion capability
offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is
not supported.</p>
<dl class="class">
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion'</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new vMotion
policy that applies when a host is evacuated, see
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec.capability">
<em class="property">property </em><code class="sig-name descname">capability</code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec.capability" title="Permalink to this definition"></a></dt>
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a vMotion policy that applies
when a host is evacuated, see
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info.capability">
<em class="property">property </em><code class="sig-name descname">capability</code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info.capability" title="Permalink to this definition"></a></dt>
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.content.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.content package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.vcenter.compute.policies.capabilities.vm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.compute.policies.capabilities.vm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>