mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
1182 lines
100 KiB
HTML
1182 lines
100 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
|
|||
|
|
<title>com.vmware.vcenter.compute.policies.capabilities package — vSphere Automation SDK for Python. 7.0.3.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<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 type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.vcenter.compute.policies.capabilities.vm package" href="com.vmware.vcenter.compute.policies.capabilities.vm.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vcenter.compute.policies package" href="com.vmware.vcenter.compute.policies.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.3.0
|
|||
|
|
</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.oauth2_client">com.vmware.oauth2_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" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.vcenter.compute.policies.capabilities package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.vcenter.compute.policies.capabilities.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">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-package"></span><h1>com.vmware.vcenter.compute.policies.capabilities package<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html">com.vmware.vcenter.compute.policies.capabilities.vm package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html">com.vmware.vcenter.compute.policies.capabilities.vm.placement package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<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.cluster_scale_in_ignore_vm_capabilities_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-cluster-scale-in-ignore-vm-capabilities-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client</span></code>
|
|||
|
|
module provides classes for the Scale-In Ignore Virtual Machine Capabilities
|
|||
|
|
capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud
|
|||
|
|
on AWS is not supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_capabilities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_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 policy
|
|||
|
|
to ignore virtual machine capabilities when scaling-in a cluster, 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>. When considering
|
|||
|
|
scaling-in a cluster, policies that have been created with one of the
|
|||
|
|
listed <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_capabilities</span></code> are ignored for virtual machines
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> in VMware Cloud on
|
|||
|
|
AWS. Usage beyond VMware Cloud on AWS is not supported. <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>) – When considering scaling-in a cluster, policies that have been
|
|||
|
|
created with one of the listed <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_capabilities</span></code>
|
|||
|
|
are ignored for virtual machines that have this tag. <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>vm_capabilities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – When considering scaling-in a cluster, policies that have been
|
|||
|
|
created with one of these capabilities are ignored for virtual
|
|||
|
|
machines that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code>.
|
|||
|
|
This <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> must contain at least one item. Currently, the
|
|||
|
|
only allowed capability identifier is
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client</span></code>.
|
|||
|
|
In the future, other capabilities may be specified. <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 contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability:VirtualMachine</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability: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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_capabilities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_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 policy to ignore virtual
|
|||
|
|
machine capabilities when scaling-in a cluster, 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>. When considering
|
|||
|
|
scaling-in a cluster, policies that have been created with one of the
|
|||
|
|
listed <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_capabilities</span></code> are ignored for virtual machines that
|
|||
|
|
have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> in VMware Cloud on AWS. Usage
|
|||
|
|
beyond VMware Cloud on AWS is not supported. <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>) – When considering scaling-in a cluster, policies that have been
|
|||
|
|
created with one of the listed <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_capabilities</span></code> are
|
|||
|
|
ignored for virtual machines that have this tag. <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>vm_capabilities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – When considering scaling-in a cluster, policies that have been
|
|||
|
|
created with one of these capabilities are ignored for virtual
|
|||
|
|
machines that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code>.
|
|||
|
|
<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 contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability:VirtualMachine</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability: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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_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 class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-disable-drs-vmotion-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_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.disable_drs_vmotion_client</span></code>
|
|||
|
|
module provides classes for the Disable DRS vMotion capability offered by
|
|||
|
|
vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
|||
|
|
supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_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
|
|||
|
|
DisableDrsVmotion policy, 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. <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 not be migrated away from the
|
|||
|
|
host on which they are powered on, except when the host is put into
|
|||
|
|
maintenance mode or failed over. <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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_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 DisableDrsVmotion policy,
|
|||
|
|
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. <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 not be migrated away from the
|
|||
|
|
host on which they are powered on, except when the host is put into
|
|||
|
|
maintenance mode or failed over. <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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_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 class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-host-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_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_host_affinity_client</span></code>
|
|||
|
|
module provides classes for the VM Host affinity capability offered by vCenter
|
|||
|
|
in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_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 virtual
|
|||
|
|
machine to host affinity policy, 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>. Virtual machines
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be affine to
|
|||
|
|
hosts that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code> in VMware
|
|||
|
|
Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
|
|||
|
|
<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 affine to the hosts
|
|||
|
|
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code>. <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>host_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 host. Virtual
|
|||
|
|
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be affine to
|
|||
|
|
hosts with this tag. <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:HostSystem</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:HostSystem</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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_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 virtual machine to host
|
|||
|
|
affinity policy, 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>. Virtual machines
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be affine to hosts
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code> in VMware Cloud on
|
|||
|
|
AWS. Usage beyond VMware Cloud on AWS is not supported. <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 affine to the hosts
|
|||
|
|
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code>. <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>host_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 host. Virtual
|
|||
|
|
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be affine to hosts
|
|||
|
|
with this tag. <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:HostSystem</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:HostSystem</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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_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 class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-host-anti-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_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_host_anti_affinity_client</span></code>
|
|||
|
|
module provides classes for the VM Host anti-affinity capability offered by
|
|||
|
|
vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
|||
|
|
supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_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 virtual
|
|||
|
|
machine to host anti-affinity policy, 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>. Virtual machines
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be
|
|||
|
|
anti-affine to hosts that have the tag indicated by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code> in VMware Cloud on AWS. Usage beyond VMware
|
|||
|
|
Cloud on AWS is not supported. <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 anti-affine to the hosts
|
|||
|
|
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code>. <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>host_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 host. Virtual
|
|||
|
|
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be anti-affine
|
|||
|
|
to hosts with this tag. <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:HostSystem</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:HostSystem</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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_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 virtual machine to host
|
|||
|
|
anti-affinity policy, 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>. Virtual machines
|
|||
|
|
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be anti-affine to
|
|||
|
|
hosts that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code> in VMware Cloud
|
|||
|
|
on AWS. Usage beyond VMware Cloud on AWS is not supported. <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 anti-affine to the hosts
|
|||
|
|
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code>. <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>host_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 host. Virtual
|
|||
|
|
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be anti-affine to
|
|||
|
|
hosts with this tag. <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:HostSystem</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:HostSystem</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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_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 class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-vm-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_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_vm_affinity_client</span></code>
|
|||
|
|
module provides classes for the VM-VM affinity capability offered by vCenter in
|
|||
|
|
VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_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 VM-VM
|
|||
|
|
affinity policy, 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>. 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
|
|||
|
|
affined to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on
|
|||
|
|
AWS is not supported. <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 affined to each other.
|
|||
|
|
<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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_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 VM-VM affinity policy, 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>. 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> are affined to
|
|||
|
|
each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
|||
|
|
supported. <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 affined to each other.
|
|||
|
|
<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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_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 class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">
|
|||
|
|
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-vm-anti-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_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_vm_anti_affinity_client</span></code>
|
|||
|
|
module provides classes for the VM VM anti-affinity capability offered by
|
|||
|
|
vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not
|
|||
|
|
supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_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 VM-VM
|
|||
|
|
anti-affinity policy, 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>. 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
|
|||
|
|
anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud
|
|||
|
|
on AWS is not supported. <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 anti-affine to each other.
|
|||
|
|
<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.
|
|||
|
|
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.</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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_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 VM-VM anti-affinity policy,
|
|||
|
|
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>. 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> are
|
|||
|
|
anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud
|
|||
|
|
on AWS is not supported. <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 are anti-affine to each other.
|
|||
|
|
<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.</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.</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.
|
|||
|
|
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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info.capability">
|
|||
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the discriminator value</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_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.compute.policies.capabilities.vm.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute.policies.capabilities.vm package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
<a href="com.vmware.vcenter.compute.policies.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.compute.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2021, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/readthedocs/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>
|