<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="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">Capabilities</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>create_spec_type=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</li>
<li><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</li>
<li><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
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
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.vapi.structure</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</li>
<li><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="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>
<dd><p>The resource type for the compute policy capability. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>capability=None</em>, <em>name=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
available as technical preview. It may be changed in a future
release.
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><strong>name</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</li>
<li><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>capability</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a specific compute policy capability.
<strong>Warning:</strong> This method is available as technical preview. It may be
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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
retrieved.
The parameter must be an identifier for the resource type:
<codeclass="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>
<dd><p>Returns information about the compute policy capabilities available in
this vCenter server. <strong>Warning:</strong> This method is available as technical
preview. It may be changed in a future release.</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The list of compute policy capabilities available on this vCenter
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
server. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as technical preview. It may be changed in a future release.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>capability=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
technical preview. It may be changed in a future release.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as technical preview. It may be changed in a future release.</li>
<li><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 technical preview. It may be changed
in a future release.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.compute.policies_client.Status.Compliance"title="com.vmware.vcenter.compute.policies_client.Status.Compliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status.Compliance</span></code></a>) – The compliance status of the policy on a specified object.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">Compliance</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status.Compliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Status.Compliance</span></code> class defines the compliance states a policy can
be in on a particular object. <strong>Warning:</strong> This enumeration is available as
technical preview. It may be changed in a future release.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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="descname">COMPLIANT</code><emclass="property"> = Compliance(string='COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.COMPLIANT"title="Permalink to this definition">¶</a></dt>
<dd><p>The policy is in compliance on the object. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<codeclass="descname">NOT_APPLICABLE</code><emclass="property"> = Compliance(string='NOT_APPLICABLE')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_APPLICABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The object is in a state for which the policy does not apply. <strong>Warning:</strong>
This class attribute is available as technical preview. It may be changed
<codeclass="descname">NOT_COMPLIANT</code><emclass="property"> = Compliance(string='NOT_COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_COMPLIANT"title="Permalink to this definition">¶</a></dt>
<dd><p>The policy is not in compliance on the object. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>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="descclassname">com.vmware.vcenter.compute.policies_client.</code><codeclass="descname">TagUsage</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>policies=None</em>, <em>tags=None</em>, <em>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
match the filter. <strong>Warning:</strong> This class is available as technical
preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
of this class as a return value, the attribute will contain
If None or empty, then tags used by any policy match this filter.</li>
<li><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>
This attribute is available as technical preview. It may be changed
in a future release.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.
If None or empty, then tags with any tag identifier match this
filter.</li>
<li><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.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.resource</span></code>.
If None or empty, then tags of any type match this filter.</li>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>policy=None</em>, <em>tag_type=None</em>, <em>tag=None</em>, <em>tag_name=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
available as technical preview. It may be changed in a future
release.
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.Policy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<li><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
available as technical preview. It may be changed in a future
release.
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.vapi.resource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.resource</span></code>.</li>
<li><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
available as technical preview. It may be changed in a future
release.
When clients pass a value of this class as a parameter, the
attribute <codeclass="docutils literal notranslate"><spanclass="pre">tagType</span></code> must contain the actual resource type. When
methods return a value of this class as a return value, the
attribute <codeclass="docutils literal notranslate"><spanclass="pre">tagType</span></code> will contain the actual resource type.</li>
<li><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
available as technical preview. It may be changed in a future
release.</li>
<li><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>.
<strong>Warning:</strong> This attribute is available as technical preview. It
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Returns information about the tags used by policies available in this
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>. <strong>Warning:</strong>
This method is available as technical preview. It may be changed in a
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
If None, the behavior is equivalent to a
<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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The list of tags used by policies available on this 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>.</p>
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>.
