<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
managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Capabilities</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Capabilities</span></code> class provides methods to manage compute policy
capabilities in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is
not supported. The description of the capability provides information about
the intent of a policy based on this capability. A capability provides a
type to create a policy (see
<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create"title="com.vmware.vcenter.compute_client.Policies.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>). A capability
also provides a type that describes the information returned when
retrieving information about a policy (see
<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get"title="com.vmware.vcenter.compute_client.Policies.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>). <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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">create_spec_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">info_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Capabilities.Info</span></code> class contains information about a compute policy
capability. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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
applicable to specific environments.</p></li>
<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
<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.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>.</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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.compute.policies.Capability'</span></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 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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Capabilities.Summary</span></code> class contains commonly used information about
a compute policy capability. <strong>Warning:</strong> This class is available as
Technology Preview. These are early access APIs provided to test, automate
and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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 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 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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span></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 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
applicable to specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</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
retrieved.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></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 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 applicable to specific
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CreateSpec</span></code> class contains common information used to create a new
policy 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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
server. <strong>Warning:</strong> This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">capability</span></code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.CreateSpec.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Info</span></code> class contains common information about a compute policy 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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">capability</span></code><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Info.capability"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ObjectCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ObjectCompliance</span></code> class defines the compliance states a policy can
be in on a particular object in VMware Cloud on AWS. Usage beyond VMware
Cloud on AWS is not supported. <strong>Warning:</strong> This enumeration is available
as Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change based
on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <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> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">COMPLIANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjectCompliance(string='COMPLIANT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.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 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
<codeclass="sig-name descname"><spanclass="pre">NOT_APPLICABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjectCompliance(string='NOT_APPLICABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.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 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
<codeclass="sig-name descname"><spanclass="pre">NOT_COMPLIANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjectCompliance(string='NOT_COMPLIANT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.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 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
<codeclass="sig-name descname"><spanclass="pre">UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjectCompliance(string='UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The object has an unknown compliance state. <strong>Warning:</strong> This class
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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Status</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Status</span></code> class describes the current status of a compute policy 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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><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.
<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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">TagUsage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TagUsage</span></code> class provides methods to query which tags are used by
policies 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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policies</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tags</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tag_types</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_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 Technology
Preview. These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback, VMware
does not guarantee backwards compatibility and recommends against using
them in production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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 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:
<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.</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>
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:
<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.</p></li>
<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.
<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:
<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.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tag_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tag</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">tag_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">category_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TagUsage.Summary</span></code> class contains common information about a tag used
by a policy. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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 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.Policy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<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
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.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>.</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
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 <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.</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
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>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 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>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute.policies_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> 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
applicable to specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<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.
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
