<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-package"></span><h1>com.vmware.appliance.vcenter.settings.v1.config.components.inventory package<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory"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-appliance-vcenter-settings-v1-config-components-inventory-cluster-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client"title="Permalink to this headline">¶</a></h2>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the cluster</p></li>
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Absolute path from root folder to cluster’s parent.
If None, then inventory object placed in root folder.</p></li>
<li><p><strong>ha</strong> (<aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of vsphere HA configurations for clusters.
If None, then HA configurations are not set.</p></li>
<li><p><strong>ha_vm_overrides</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Settings for HA vm overrides.</p></li>
<li><p><strong>drs</strong> (<aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide configuration of the vSphere DRS service.</p></li>
<li><p><strong>drs_vm_overrides</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of virtual machine configurations for the vSphere DRS service.
Each entry applies to one virtual machine. If a virtual machine is
not specified in this list, the service uses the default settings
<li><p><strong>proactive_ha</strong> (<aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide configuration of the vSphere InfraUpdateHA service.
If None or empty, the value is skipped.</p></li>
<li><p><strong>hosts</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host configuration on the datacenter.
If None, then no hosts present in the datacenter.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the cluster.
If None, then no permissions defined on this inventory object.</p></li>
<li><p><strong>resource_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of Resource pools.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">OptionValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</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.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue"title="Permalink to this definition">¶</a></dt>
<p>Describes the key/value pair of a configured option.</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>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the option using dot notation to reflect the option’s
position in a hierarchy. For example, you might have an option
called “Ethernet” and another option that is a child of that called
“Connection”. In this case, the key for the latter could be defined
as “Ethernet.Connection”</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The value of the option. The Any data object type enables you to
define any value for the option. Typically, however, the value of
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_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.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datacenter-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Datacenter</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">standalone_hosts</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.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter"title="Permalink to this definition">¶</a></dt>
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Absolute path of the inventory object’s parent.
If None, then inventory object placed in root folder.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the datacenter.
If None, then no permissions defined on this inventory object.</p></li>
<li><p><strong>standalone_hosts</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host configuration on the datacenter.
If None, then no hosts present in the datacenter.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_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.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-datastore-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Datastore</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">summary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> class defines the spec for datastore configurations in
vCenter Server.</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>) – The identifier of the datastore.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
<li><p><strong>summary</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Summary</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Summary of the datastore.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the datastore.
If None, then no permissions defined on this inventory object.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">MaintenanceModeState</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">MaintenanceModeState</span></code> class defines the maintenance mode states of
the datastore.</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MaintenanceModeState</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ENTERING_MAINTENANCE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceModeState(string='ENTERING_MAINTENANCE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.ENTERING_MAINTENANCE"title="Permalink to this definition">¶</a></dt>
<dd><p>Started entering maintenance mode, but not finished. This could happen when
waiting for user input or for long-running vmotions to complete.</p>
<codeclass="sig-name descname"><spanclass="pre">IN_MAINTENANCE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceModeState(string='IN_MAINTENANCE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.IN_MAINTENANCE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NORMAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceModeState(string='NORMAL')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.NORMAL"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PodStorageDrsEntry</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">storage_drs_config</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StorageDrsConfigInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pod_config</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StorageDrsPodConfigInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo"title="Permalink to this definition">¶</a></dt>
<p>The StorageDrsConfigInfo class contains spec to define pod-wide
configuration information for the storage DRS service.</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>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether or not storage DRS is enabled.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StoragePod</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pod_storage_drs_entry</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod"title="Permalink to this definition">¶</a></dt>
<p>The StoragePod class contains spec to define storage pod in vCenter Server.</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>) – Identifier of the Storage Pod.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
<li><p><strong>pod_storage_drs_entry</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PodStorageDrsEntry</span></code></a>) – Storage DRS related attributes of the Storage Pod.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the Storage Pod.
If None, then no permissions defined on this inventory object.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">multiple_host_access</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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">maintenance_mode</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.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Summary</span></code> class defines the datastore summary properties.</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>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum capacity of this datastore, in bytes. This value is updated
periodically by the server. It can be explicitly refreshed with the
Refresh operation.</p></li>
<li><p><strong>multiple_host_access</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – More than one host in the datacenter has been configured with
access to the datastore. This is only provided by VirtualCenter.
If None, then the datastore not configured with access from more
than one host.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of file system volume, such as VMFS or NFS.</p></li>
<li><p><strong>maintenance_mode</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MaintenanceModeState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The current maintenance mode state of the datastore.
If None, then the current maintenance mode state of the datastore
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-folder-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Folder</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">datacenter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</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.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FolderDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of datastore folders.
If None. then there are no datastore folders.</p></li>
<li><p><strong>datacenter</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FolderDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of datacenter folders.
If None. then there are no datacenter folders.</p></li>
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FolderDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of vm folders.
If None. then there are no vm folders.</p></li>
<li><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FolderDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of network folders.
If None. then there are no network folders.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FolderDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of host folders.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><codeclass="sig-name descname"><spanclass="pre">FolderDetails</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails"title="Permalink to this definition">¶</a></dt>
<p>The FolderDetails class contains spec to define folder in vCenter Server.</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 vCenter Server folder.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Absolute path of the inventory object’s parent.
If None, then inventory object placed in root folder.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the folder.
If None, then no permissions defined on this inventory object.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_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.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-host-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostConfig</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">permissions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">parent_path</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.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostConfig</span></code> class contains attributes describing the configuration
of a Stand alone host.</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 host</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permission on the host.
If None, then no permissions defined on this inventory object.</p></li>
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of this inventory object.
If None, then inventory object placed in root folder.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_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.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-network-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Network</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network"title="Permalink to this definition">¶</a></dt>
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions defined on the network.
If None, then no permissions defined on this inventory object.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_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.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-resourcepool-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ResourceAllocationInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">expandable_reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">limit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">shares</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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ResourceAllocationInfo</span></code> class contains resource allocation
information of a resource pool.</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>reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Amount of resource that is guaranteed available to a resource pool.
Reserved resources are not wasted if they are not used. If the
utilization is less than the reservation, the resources can be
utilized by other running virtual machines. Units are MB fo memory,
and MHz for CPU.</p></li>
<li><p><strong>expandable_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – In a resource pool with an expandable reservation, the reservation
can grow beyond the specified value, if the parent resource pool
has unreserved resources. A non-expandable reservation is called a
fixed reservation.</p></li>
<li><p><strong>limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The utilization of a resource pool will not exceed this limit, even
if there are available resources. This is typically used to ensure
a consistent performance of resource pools independent of available
resources. If set to -1, then there is no fixed limit on resource
usage (only bounded by available resources and shares). Units are
MB for memory, and MHz for CPU.</p></li>
<li><p><strong>shares</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Shares</span></code></a>) – Shares are used in case of resource contention.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ResourcePool</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">parent_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">child_resource_pools</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool"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 vCenter Server resource pool.</p></li>
<li><p><strong>parent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent name for the resource pool.
If None, then inventory object placed in root folder.</p></li>
<li><p><strong>child_resource_pools</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of the child resource pools contained in this resource
pool.
If None or empty, the value is skipped.</p></li>
<li><p><strong>config</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourcePoolSummary</span></code></a>) – Summary of the Resource pools.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permission on the resourcepool.
If None, then no permissions defined on this inventory object.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ResourcePoolSummary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_allocation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_allocation</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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Shares</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">level</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">shares</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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares"title="Permalink to this definition">¶</a></dt>
<li><p><strong>level</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Shares.Level</span></code></a>) – The allocation level. It maps to a pre-determined set of numeric
values for shares. If the shares value does not map to a predefined
size, then the level is set as CUSTOM.</p></li>
<li><p><strong>shares</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) –<p>When <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Shares.level</span></code> is set to CUSTOM, it is the number of
shares allocated. Otherwise, this value is ignored.</p>
<p>There is no unit for this value. It is a relative measure based on
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Level</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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Shares.Level</span></code> class defines the possible values for the allocation
level.</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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Level</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CUSTOM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Level(string='CUSTOM')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.CUSTOM"title="Permalink to this definition">¶</a></dt>
<dd><p>If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, in case there is resource contention the server uses the
shares value to determine the resource allocation.</p>
<codeclass="sig-name descname"><spanclass="pre">HIGH</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Level(string='HIGH')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.HIGH"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">LOW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Level(string='LOW')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.LOW"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>For CPU: Shares = 500 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 5 * virtual machine memory size in MB.</p>
<codeclass="sig-name descname"><spanclass="pre">NORMAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Level(string='NORMAL')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.NORMAL"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>For CPU: Shares = 1000 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 10 * virtual machine memory size in MB.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_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.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory"title="Permalink to this definition">¶</a></dt>