<spanid="com-vmware-vcenter-storage-package"></span><h1>com.vmware.vcenter.storage package<aclass="headerlink"href="#module-com.vmware.vcenter.storage"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-storage-policies-client-module"></span><h2>com.vmware.vcenter.storage.policies_client module<aclass="headerlink"href="#module-com.vmware.vcenter.storage.policies_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.storage.policies_client.</code><codeclass="descname">Compliance</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance"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>status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Compliance.FilterSpec</span></code> class contains complianceStatus used to
filter the results when listing entities (see <aclass="reference internal"href="#com.vmware.vcenter.storage.policies_client.Compliance.list"title="com.vmware.vcenter.storage.policies_client.Compliance.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Compliance.list()</span></code></a>).
This class was added in vSphere API 6.7.</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"><strong>status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status"title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Compliance.Status</span></code></a>) – Compliance Status that a virtual machine must have to match the
filter. This attribute was added in vSphere API 6.7.</td>
<emclass="property">class </em><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status"title="Permalink to this definition">¶</a></dt>
<p>This enumeration defines the set of status values for a compliance
operation. This enumeration was added in vSphere API 6.7.</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"> = Status(string='COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.COMPLIANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Entity is in compliance. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">NON_COMPLIANT</code><emclass="property"> = Status(string='NON_COMPLIANT')</em><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.NON_COMPLIANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Entity is out of compliance. This class attribute was added in vSphere API
<codeclass="descname">NOT_APPLICABLE</code><emclass="property"> = Status(string='NOT_APPLICABLE')</em><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.NOT_APPLICABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Compliance computation is not applicable for this entity because it does
not have any storage requirement that apply to the object-based datastore
on which the entity is placed. This class attribute was added in vSphere
<codeclass="descname">OUT_OF_DATE</code><emclass="property"> = Status(string='OUT_OF_DATE')</em><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.OUT_OF_DATE"title="Permalink to this definition">¶</a></dt>
<dd><p>Compliance status becomes out of date when the profile associated with the
entity is edited and not applied. The compliance status will remain out of
date until the latest policy is applied to the entity. This class attribute
<codeclass="descname">UNKNOWN</code><emclass="property"> = Status(string='UNKNOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Compliance status of the entity is not known. This class attribute was
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>vm=None</em>, <em>vm_home=None</em>, <em>disks=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.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>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of virtual machine. This attribute was added in vSphere
API 6.7.
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">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><strong>vm_home</strong> (<aclass="reference internal"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status"title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><codeclass="xrefpypy-classdocutilsliteralnotranslate"><spanclass="pre">Compliance.Status</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Compliance status of the virtual machine home. This attribute was
added in vSphere API 6.7.
If None or empty, vmHome is not associated with a storage policy.</li>
<li><strong>disks</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.storage.policies_client.Compliance.Status"title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Compliance.Status</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of the virtual hard disk. This attribute was added in vSphere
API 6.7.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.Compliance.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns compliance information about entities matching the filter
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Compliance.FilterSpec</span></code></a>) – compliance status of matching entities for which information should
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.storage.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.storage.policies_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.storage.policies_client.</code><codeclass="descname">VM</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.VM"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>vm_home=None</em>, <em>disks=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.VM.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>vm_home</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the virtual machine home is
associated with the given storage policy. This attribute was added
in vSphere API 6.7.</li>
<li><strong>disks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of the virtual disks that are associated with the given
storage policy. This attribute was added in vSphere API 6.7.
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.vm.hardware.Disk</span></code>. When methods return a
value of this class as a return value, the attribute will contain
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage.policies_client.VM.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the virtual machines and/or their virtual
disks that are associated with the given storage policy. This method
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>.
