<spanid="com-vmware-vcenter-compute-package"></span><h1>com.vmware.vcenter.compute package<aclass="headerlink"href="#module-com.vmware.vcenter.compute"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-compute-policies-client-module"></span><h2>com.vmware.vcenter.compute.policies_client module<aclass="headerlink"href="#module-com.vmware.vcenter.compute.policies_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies_client</span></code> module provides classes for
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">Capabilities</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">create_spec_type=None</em>, <emclass="sig-param">info_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the capability. <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
<li><p><strong>create_spec_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the class used to create a policy based on this
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</p></li>
<li><p><strong>info_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the class returned when retrieving information about
<codeclass="sig-name descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.compute.policies.Capability'</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">capability=None</em>, <emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability. <strong>Warning:</strong> This attribute is
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the capability. <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
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">capability</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability for which information should be
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">capability=None</em>, <emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
<emclass="property">property </em><codeclass="sig-name descname">capability</code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.CreateSpec.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">capability=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
<emclass="property">property </em><codeclass="sig-name descname">capability</code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Info.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">ObjectCompliance</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">COMPLIANT</code><emclass="property"> = ObjectCompliance(string='COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">NOT_APPLICABLE</code><emclass="property"> = ObjectCompliance(string='NOT_APPLICABLE')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">NOT_COMPLIANT</code><emclass="property"> = ObjectCompliance(string='NOT_COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">Status</code><spanclass="sig-paren">(</span><emclass="sig-param">status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance"title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ObjectCompliance</span></code></a>) – The compliance status of the policy on a specified object.
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="sig-name descname">TagUsage</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">FilterSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">policies=None</em>, <emclass="sig-param">tags=None</em>, <emclass="sig-param">tag_types=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TagUsage.FilterSpec</span></code> class contains attributes used to filter the
results when listing the tags used by policies as available in this vCenter
server (see <aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.TagUsage.list"title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">TagUsage.list()</span></code></a>). If multiple attributes are specified,
only the tags used by policies that match an element of each attribute
<li><p><strong>policies</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers that compute policies must have to match the filter.
If None or empty, then tags used by any policy match this filter.</p></li>
<li><p><strong>tags</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers that tags must have to match the filter. <strong>Warning:</strong>
<li><p><strong>tag_types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers that tag types must have to match the filter.
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">policy=None</em>, <emclass="sig-param">tag_type=None</em>, <emclass="sig-param">tag=None</em>, <emclass="sig-param">tag_name=None</em>, <emclass="sig-param">category_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy that uses the tag indicated by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagUsage.Summary.tag</span></code>. <strong>Warning:</strong> This attribute is
<li><p><strong>tag_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the tag type used by the policy indicated by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.resource</span></code>.</p></li>
<li><p><strong>tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the tag used by the policy indicated by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
attribute <codeclass="docutils literal notranslate"><spanclass="pre">tagType</span></code> will contain the actual resource type.</p></li>
<li><p><strong>tag_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the tag used by the policy indicated by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
<li><p><strong>category_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the category that has <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagUsage.Summary.tag</span></code>.
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage.list"title="Permalink to this definition">¶</a></dt>
vCenter server matching the <aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TagUsage.FilterSpec</span></code></a> in VMware
Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
<strong>Warning:</strong> This method 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
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TagUsage.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification for matching tags used by policies.
<aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TagUsage.FilterSpec</span></code></a> with all attributes None, which means
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
