mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
1073 lines
110 KiB
HTML
1073 lines
110 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
|
|||
|
|
<title>com.vmware.appliance.vcenter.settings.v1.config.components.inventory package — vSphere Automation SDK for Python. 7.0.3.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.appliance.vcenter.settings.v1.config.components package" href="com.vmware.appliance.vcenter.settings.v1.config.components.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.3.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.html">com.vmware.appliance package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.html">com.vmware.appliance.vcenter.settings package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.html">com.vmware.appliance.vcenter.settings.v1.config package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.components.html">com.vmware.appliance.vcenter.settings.v1.config.components package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.appliance.vcenter.settings.v1.config.components.inventory package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-package"></span><h1>com.vmware.appliance.vcenter.settings.v1.config.components.inventory package<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client</span></code>
|
|||
|
|
module provides classes to manage the vCenter Server Inventory cluster
|
|||
|
|
configurations</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">ClusterConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_vm_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drs_vm_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proactive_ha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pools</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterConfigInfo</span></code> class contains attributes describing the complete
|
|||
|
|
configuration of a cluster. It contains cluster-wide configurations of DRS,
|
|||
|
|
HA VSAN Cluster etc.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the cluster</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Settings for HA vm overrides.</p></li>
|
|||
|
|
<li><p><strong>drs</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide configuration of the vSphere DRS service.</p></li>
|
|||
|
|
<li><p><strong>drs_vm_overrides</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
|||
|
|
for that virtual machine.
|
|||
|
|
If None or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>rules</strong> (<a class="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.Rule" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide rules.
|
|||
|
|
If None or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>groups</strong> (<a class="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.Group" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide groups.
|
|||
|
|
If None or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>proactive_ha</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Resource pools.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">OptionValue</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Describes the key/value pair of a configured option.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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
|
|||
|
|
an option is of type String or Integer.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name
|
|||
|
|
com.vmware.appliance.vcenter.settings.v1.config.components.inventory
|
|||
|
|
.datacenter} module provides classes to manage the datacenter config.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.</span></code><code class="sig-name descname"><span class="pre">Datacenter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standalone_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code> class contains spec to define datacenter in vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the datacenter.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Host configuration on the datacenter.
|
|||
|
|
If None, then no hosts present in the datacenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name
|
|||
|
|
com.vmware.appliance.vcenter.settings.v1.config.components.inventory
|
|||
|
|
.datastore} module provides classes to manage the datastore and storagepod
|
|||
|
|
config.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">Datastore</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Datastore</span></code> class defines the spec for datastore configurations in
|
|||
|
|
vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
|||
|
|
<li><p><strong>summary</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Summary of the datastore.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the datastore.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">MaintenanceModeState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code> class defines the maintenance mode states of
|
|||
|
|
the datastore.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code></a> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.ENTERING_MAINTENANCE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">ENTERING_MAINTENANCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='ENTERING_MAINTENANCE')</span></em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.IN_MAINTENANCE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">IN_MAINTENANCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='IN_MAINTENANCE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.IN_MAINTENANCE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Successfully entered maintenance mode.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.NORMAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NORMAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceModeState(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState.NORMAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Default state.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">PodStorageDrsEntry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage_drs_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The PodStorageDrsEntry class contains spec to define storage DRS related
|
|||
|
|
attributes of the Storage Pod.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>storage_drs_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDrsConfigInfo</span></code></a>) – Storage DRS configuration.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StorageDrsConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The StorageDrsConfigInfo class contains spec to define storage DRS
|
|||
|
|
configurations.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>pod_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDrsPodConfigInfo</span></code></a>) – Pod-wide configuration information for the storage DRS service.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StorageDrsPodConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The StorageDrsConfigInfo class contains spec to define pod-wide
|
|||
|
|
configuration information for the storage DRS service.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether or not storage DRS is enabled.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StoragePod</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pod_storage_drs_entry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The StoragePod class contains spec to define storage pod in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
|||
|
|
<li><p><strong>pod_storage_drs_entry</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">PodStorageDrsEntry</span></code></a>) – Storage DRS related attributes of the Storage Pod.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the Storage Pod.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.</span></code><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiple_host_access</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maintenance_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Summary</span></code> class defines the datastore summary properties.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of file system volume, such as VMFS or NFS.</p></li>
|
|||
|
|
<li><p><strong>maintenance_mode</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaintenanceModeState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The current maintenance mode state of the datastore.
|
|||
|
|
If None, then the current maintenance mode state of the datastore
|
|||
|
|
is set to normal.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name
|
|||
|
|
com.vmware.appliance.vcenter.settings.v1.config.components.inventory .folder}
|
|||
|
|
module provides classes to manage the folder config.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">Folder</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datacenter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The Folder class contains spec to define folder in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of datastore folders.
|
|||
|
|
If None. then there are no datastore folders.</p></li>
|
|||
|
|
<li><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of datacenter folders.
|
|||
|
|
If None. then there are no datacenter folders.</p></li>
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of vm folders.
|
|||
|
|
If None. then there are no vm folders.</p></li>
|
|||
|
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of network folders.
|
|||
|
|
If None. then there are no network folders.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FolderDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of host folders.
|
|||
|
|
If None. then there are no host folders.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">FolderDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The FolderDetails class contains spec to define folder in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the folder.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name com.vmware.appliance.vcenter.settings.v1.config.components
|
|||
|
|
inventory.host} module provides classes to manage the ConfigManagement.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.</span></code><code class="sig-name descname"><span class="pre">HostConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">HostConfig</span></code> class contains attributes describing the configuration
|
|||
|
|
of a Stand alone host.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the host</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of this inventory object.
|
|||
|
|
If None, then inventory object placed in root folder.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name
|
|||
|
|
com.vmware.appliance.vcenter.settings.v1.config.components.inventory .network}
|
|||
|
|
module provides classes to manage the network config.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The Network class contains spec to define standard network in vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the network.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path of the inventory object’s parent.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the network.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">
|
|||
|
|
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name com.vmware.appliance.vcenter.settings.v1.config.components
|
|||
|
|
inventory.resourcepool} module provides classes to manage the ConfigManagement.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourceAllocationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expandable_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code> class contains resource allocation
|
|||
|
|
information of a resource pool.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shares</span></code></a>) – Shares are used in case of resource contention.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourcePool</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">child_resource_pools</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> class contains information about resource pools
|
|||
|
|
present in the cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server resource pool.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of the virtual machines contained in this resource
|
|||
|
|
pool.
|
|||
|
|
If None or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePoolSummary</span></code></a>) – Summary of the Resource pools.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permission on the resourcepool.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">ResourcePoolSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePoolSummary</span></code> class provides summary of ResourcePool.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for CPU.</p></li>
|
|||
|
|
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for memory.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">Shares</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Shares</span></code> class provides specification of shares.</p>
|
|||
|
|
<p>Shares are used to determine relative allocation between resource
|
|||
|
|
consumers. In general, a consumer with more shares gets proportionally more
|
|||
|
|
of the resource, subject to certain other constraints.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>level</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>When <code class="xref py py-attr docutils literal notranslate"><span class="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
|
|||
|
|
the settings for other resource pools.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Level</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Shares.Level</span></code> class defines the possible values for the allocation
|
|||
|
|
level.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Level</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.CUSTOM">
|
|||
|
|
<code class="sig-name descname"><span class="pre">CUSTOM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='CUSTOM')</span></em><a class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, in case there is resource contention the server uses the
|
|||
|
|
shares value to determine the resource allocation.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.HIGH">
|
|||
|
|
<code class="sig-name descname"><span class="pre">HIGH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='HIGH')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.HIGH" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 2000 * nmumber of virtual CPUs.</dt><dd><p>For Memory: Shares = 20 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.LOW">
|
|||
|
|
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='LOW')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.LOW" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 500 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 5 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.NORMAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NORMAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level.NORMAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 1000 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 10 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-vm-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The {\@name com.vmware.appliance.vcenter.settings.v1.config.components
|
|||
|
|
inventory.vm} module provides classes to manage the ConfigManagement.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.</span></code><code class="sig-name descname"><span class="pre">ConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hardware</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConfigInfo</span></code> class provides configuration of a VirtualMachine.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hardware</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualHardware</span></code></a>) – Hardware configuration of the VirtualMachine.</p></li>
|
|||
|
|
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource limits for the CPU.</p></li>
|
|||
|
|
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource limits for the memory.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.</span></code><code class="sig-name descname"><span class="pre">ResourceAllocationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code> class provides resource allocation of
|
|||
|
|
VirtualMachine.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Amount of resource that is guaranteed available. Units are MB for
|
|||
|
|
memory, MHz for CPU.
|
|||
|
|
If None, then there is no reservation.</p></li>
|
|||
|
|
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The utilization will not exceed this limit, even if there are
|
|||
|
|
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, MHz for CPU.
|
|||
|
|
If None, then there is no limit.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.</span></code><code class="sig-name descname"><span class="pre">VirtualHardware</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_cpu</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_mb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualHardware</span></code> class provides the virtual hardware configuration
|
|||
|
|
of a VirtualMachine.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>num_cpu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of virtual CPUs.</p></li>
|
|||
|
|
<li><p><strong>memory_mb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Memory size in MB.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualMachineConfig">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.</span></code><code class="sig-name descname"><span class="pre">VirtualMachineConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualMachineConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineConfig</span></code> class contains information about virtual
|
|||
|
|
machine configurations present in the cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server virtual machine configuration.</p></li>
|
|||
|
|
<li><p><strong>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent path for the virtual machine configuration.
|
|||
|
|
If None, then virtual machine placed in root folder.</p></li>
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of current ResourcePool defining the resource
|
|||
|
|
allocation for this virtual machine.
|
|||
|
|
If None, this is a Template VM or current user session has no
|
|||
|
|
access to the resource pool.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configuration of the VirtualMachine.
|
|||
|
|
If None, then there is no configuration.</p></li>
|
|||
|
|
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Permission</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Permissions defined on the virtual machine.
|
|||
|
|
If None, then no permissions defined on this inventory object.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
<a href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html" class="btn btn-neutral float-right" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
<a href="com.vmware.appliance.vcenter.settings.v1.config.components.html" class="btn btn-neutral float-left" title="com.vmware.appliance.vcenter.settings.v1.config.components package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2021, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|||
|
|
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|