<spanid="com-vmware-vcenter-lcm-package"></span><h1>com.vmware.vcenter.lcm package<aclass="headerlink"href="#module-com.vmware.vcenter.lcm"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-lcm-common-client-module"></span><h2>com.vmware.vcenter.lcm.common_client module<aclass="headerlink"href="#module-com.vmware.vcenter.lcm.common_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.upgrade</span></code> module provides classes for upgrading
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize"title="com.vmware.vcenter.lcm.common_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If <codeclass="docutils literal notranslate"><spanclass="pre">#ApplianceSize</span></code> is not provided, will use the size of the
source VCSA</p></li>
<li><p><strong>thin_disk_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.StorageSize"title="com.vmware.vcenter.lcm.common_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If <codeclass="docutils literal notranslate"><spanclass="pre">#StorageSize</span></code> is not provided, will use the diskSize of the
source VCSA.</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>ova_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.OvaInfo"title="com.vmware.vcenter.lcm.common_client.OvaInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvaInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Location of custom OVA for deployment.
If None use the OVA file for the desired version in the configured
repository.</p></li>
<li><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This key describes the enabling option for the VMware’s Customer
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ApplianceDeploymentConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">appliance</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceDeploymentConfig"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ApplianceDeploymentConfig</span></code> class contains the new appliance
deployment configuration.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.ApplianceDeployment"title="com.vmware.vcenter.lcm.common_client.ApplianceDeployment"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceDeployment</span></code></a>) – Description of the new appliance configuration.</p></li>
<li><p><strong>location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.Location"title="com.vmware.vcenter.lcm.common_client.Location"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Location</span></code></a>) – ESX or VC on which to deploy the appliance.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ApplianceSize</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code> class defines the size of the appliance (CPU and
memory) to be deployed.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize"title="com.vmware.vcenter.lcm.common_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='LARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.LARGE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MEDIUM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='MEDIUM')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.MEDIUM"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SMALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='SMALL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.SMALL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TINY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='TINY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.TINY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">XLARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='XLARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.XLARGE"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Connection</span></code> class contains information for deployment location</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the ESX/VC host. If a DNS
resolvable name is provided, it must be resolvable from the source
appliance.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A username with administrative privileges on the ESX/VC host.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Connection.username</span></code> on the ESX/VC host.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The port number for the ESX/VC.
If None, defaults to 443</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to True</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Thumbprint for SSL verification.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> if false, this field is not required</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.lcm.common_client.Esx">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Esx</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">connection</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement_config</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Esx"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Esx</span></code> class contains ESX configuration.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.Connection"title="com.vmware.vcenter.lcm.common_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>placement_config</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.EsxPlacementConfig"title="com.vmware.vcenter.lcm.common_client.EsxPlacementConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EsxPlacementConfig</span></code></a>) – The location of the new version of the vCSA on the desired ESX.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">EsxPlacementConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_pool_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.EsxPlacementConfig"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must be accessible
from the ESX host.</p></li>
<li><p><strong>network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The network of the ESX host to which the new appliance should
connect. Omit this parameter if the ESX host has one network.
If None and there is only one network configured, it will be used.</p></li>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The path to the resource pool on the ESX host in which the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HashAlgorithm</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HashAlgorithm</span></code> class defines the valid hash algorithms.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm"title="com.vmware.vcenter.lcm.common_client.HashAlgorithm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HashAlgorithm</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">SHA256</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HashAlgorithm(string='SHA256')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA256"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SHA512</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HashAlgorithm(string='SHA512')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA512"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Location</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">esx</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vcenter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Location"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Location</span></code> class contains configuration of appliance location.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.Esx"title="com.vmware.vcenter.lcm.common_client.Esx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Esx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.VCenter"title="com.vmware.vcenter.lcm.common_client.VCenter"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VCenter</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">OvaInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_verify</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_hash</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hash_algorithm</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.OvaInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">OvaInfo</span></code> class defines the OVA file location info.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVA file for installation. It can be web URL or
absolute filepath i.e <aclass="reference external"href="https://server.com/appliance.ova">https://server.com/appliance.ova</a> or
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether SSL verification is required for the ova
location.
If None defaults to True</p></li>
<li><p><strong>ssl_hash</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Hash to verify the SSL OVA location. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is false this
filed can be omitted. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is true and this field is
ommited a CA based validation will be used. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is
true and this field is provided will be used for SSL validation.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> will be used for SSL validation.</p></li>
<li><p><strong>hash_algorithm</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm"title="com.vmware.vcenter.lcm.common_client.HashAlgorithm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HashAlgorithm</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The hash algorithm (SHA256, SHA512) used to calculate the checksum.
If not specified the default checksum algorithm is
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question</span></code> class describes a item of information that must be
provided by the user in order to perform the update.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>data_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID of the data item
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.common.dataitem</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>text</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Label for the item</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the item</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.Question.InputType"title="com.vmware.vcenter.lcm.common_client.Question.InputType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.InputType</span></code></a>) – The type of the field.</p></li>
<li><p><strong>allowed_values</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of allowed values
allowedValues If None any value is valid.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">InputType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Question.InputType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question.InputType</span></code> class defines the supported field types for
questions.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InputType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BOOLEAN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">InputType(string='BOOLEAN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Question.InputType.BOOLEAN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PASSWORD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">InputType(string='PASSWORD')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Question.InputType.PASSWORD"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PLAIN_TEXT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">InputType(string='PLAIN_TEXT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.Question.InputType.PLAIN_TEXT"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StorageSize</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.StorageSize"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StorageSize</span></code> class defines the storage size of the appliance to be
deployed.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.StorageSize"title="com.vmware.vcenter.lcm.common_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageSize(string='LARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.StorageSize.LARGE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REGULAR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageSize(string='REGULAR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.StorageSize.REGULAR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">XLARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageSize(string='XLARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.StorageSize.XLARGE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.common_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VCenter</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">connection</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement_config</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.common_client.VCenter"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VCenter</span></code> class contains configuration of the VC that hosts/will host
an appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.Connection"title="com.vmware.vcenter.lcm.common_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>placement_config</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.common_client.VcPlacementConfig"title="com.vmware.vcenter.lcm.common_client.VcPlacementConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VcPlacementConfig</span></code></a>) –<p>The location of the new version of the vCSA on the desired vCenter.</p>
<p>All names are case-sensitive. you can install the appliance to one
of the following destinations: 1. A resource pool in a cluster, use
‘cluster_path’. 2. A specific ESX host in a cluster, use
‘host_path’. 3. A resource pool in a specific ESX host being
managed by the current vCenter, use ‘resource_pool_path’. 4. To
install a new appliance to a specific ESX host in a cluster,
provide the ‘host_path’ key, and the ‘datastore_name’, e.g.
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VcPlacementConfig</span></code> class contains configuration of VC placement of
the target appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_folder_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Aboslute path of the VM folder. VM folder must be visible by the
Mutually exclusive between {\@vm_folder_path},
<codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>host_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Absolute path of the ESX host (FQDN/IP) in the vCenter inventory
tree.
Mutually exclusive between {\@vm_folder_path},
<codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must have the space
defined as appliance storage size.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<li><p><strong>datastore_cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore cluster on which to store the files of the appliance.
The datastore cluster must have the space defined as appliance
storage size.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<li><p><strong>network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the network. e.g. VM Network</p></li>
<spanid="com-vmware-vcenter-lcm-discovery-client-module"></span><h2>com.vmware.vcenter.lcm.discovery_client module<aclass="headerlink"href="#module-com.vmware.vcenter.lcm.discovery_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.discovery_client</span></code> module provides classes for
discovering products registered with vCenter Server and interoperability
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AssociatedProducts</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AssociatedProducts</span></code> class provides options to list, add, modify, and
delete VMware products associated with vCenter Server. Some products can be
auto-detected by the system while others can be added manually.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">product_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">deployments</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AssociatedProducts.CreateSpec</span></code> class is the specification used for
the product creation.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>product_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the product.</p></li>
<li><p><strong>deployments</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of hostname/IPs of the instances of the VMware products
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.lcm.product'</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the products interface.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">deployments</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AssociatedProducts.UpdateSpec</span></code> class is the specification for the
product update.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>deployments</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of hostname/IPs of the instances of the VMware products
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Associates a VMware product with vCenter Server manually. The product
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">product</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes or dissociates a VMware product associated with vCenter Server
which was added manually. Automatically discovered VMware products
cannot be deleted or dissociated.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>product</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An id of the product to be removed.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">product</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the detailed information of a product associated with vCenter
Server.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>product</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier of the product to be modified.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves a list of all associated VMware product deployments with
vCenter Server in the environment. The list contains both product
deployments discovered automatically and deployments registered
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">product</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Modifies a VMware product associated with vCenter Server which was
added manually. Automatically discovered VMware products cannot be
modified.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>product</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An id of the product to be modified.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><codeclass="sig-name descname"><spanclass="pre">InteropReport</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InteropReport</span></code> interface provides methods to report the
interoperability between a vCenter Server release version and the other
installed VMware products registered in the vCenter Server instance.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReleaseInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">note</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InteropReport.ReleaseInfo</span></code> class contains a product release
information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the release.</p></li>
<li><p><strong>note</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A link to the release notes of the release.
None if the release notes are not available.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Report</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">date_created</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target_product</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">products</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issues</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">summary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Report"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InteropReport.Report</span></code> class contains the interoperability report
between the target product and the other registered products in the vCenter
Server instance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>date_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the report is created.</p></li>
<li><p><strong>target_product</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.Product"title="com.vmware.vcenter.lcm.discovery_client.Product"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Product</span></code></a>) – A product against the other products are compared to. Only vCenter
Server is supported.</p></li>
<li><p><strong>products</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow"title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InteropReport.ReportRow</span></code></a>) – Interoperability matrix for the supplied target product and the
other registered products.</p></li>
<li><p><strong>issues</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications"title="com.vmware.vcenter.lcm_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Lists of issues encountered during report creation.
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if any issues encountered.</p></li>
<li><p><strong>summary</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary"title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InteropReport.ReportSummary</span></code></a>) – A summary of the interoperability matrix.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReportRow</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">product</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible_releases</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InteropReport.ReportRow</span></code> class contains the interoperability between
a given product and the target product.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>product</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.Product"title="com.vmware.vcenter.lcm.discovery_client.Product"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Product</span></code></a>) – The product to compare to the target product.</p></li>
<li><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Defines whether the product is compatible against the target
product.</p></li>
<li><p><strong>compatible_releases</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo"title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InteropReport.ReleaseInfo</span></code></a>) – A list of compatible releases of the product with the target
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReportSummary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compatible_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">incompatible_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Result</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">report</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">csv_report</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Result"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">target_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">create_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.create_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates interoperability report between a vCenter Server release
version and all registered products with the vCenter Server instance.</p>
<p>The result of this operation can be queried by calling the
com.vmware.cis.Tasks#get method where <codeclass="docutils literal notranslate"><spanclass="pre">task</span></code> is the response of this
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec"title="com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InteropReport.Spec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the target version against this interoperability check
report will be generated. If None the report will be generated for
the currently installed version of the vCenter server.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Info</span></code> class contains information about a VMware product which is
present in the customer Environemnt. The following information about the
products are present:</p>
<ulclass="simple">
<li><p>Name</p></li>
<li><p>Version</p></li>
<li><p>Deployments</p></li>
<li><p>Automatically Discovered or Manually Added</p></li>
</ul>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>installed_product</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Identifies a product and a version uniquely.</p>
<p>The identifier consists of product internal name and version.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">PRODUCT</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">PRODUCT</span></code>.</p>
</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A public official product name.</p></li>
<li><p><strong>target_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Future version of the product after upgrade.
<codeclass="docutils literal notranslate"><spanclass="pre">targetVersion</span></code> may not be applicable.</p></li>
<li><p><strong>deployments</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of hostname/IPs of the instances of the VMware products
deployed in the environment. This field would be empty for manually
added products.</p></li>
<li><p><strong>auto</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the product is auto-detected by the system or manually
added. If it is set to true it means it is auto-detected.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ProductCatalog</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ProductCatalog</span></code> class provides information which VMware products can
be associated with vCenter Server.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">versions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ProductCatalog.Summary</span></code> class contains information about each VMware
product and its corresponding versions that can be associated with vCenter
Server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A product name that the customer is aware of.</p></li>
<li><p><strong>versions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of versions the customer can select from.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves a list of all VMware products that can be associated with
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.discovery_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-lcm-update-client-module"></span><h2>com.vmware.vcenter.lcm.update_client module<aclass="headerlink"href="#module-com.vmware.vcenter.lcm.update_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.update_client</span></code> module provides classes for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.update_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Pending</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending</span></code> class provides method for listing pending minor or major
updates of vCenter Server.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Category</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.Category</span></code> class defines the type of payload this release has
on top of previous release</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Category</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='FIX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.Category.FIX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SECURITY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='SECURITY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.Category.SECURITY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UPDATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='UPDATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.Category.UPDATE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UPGRADE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='UPGRADE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.Category.UPGRADE"title="Permalink to this definition">¶</a></dt>
<dd><p>Introduces new features, significantly changes product functionality</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.Info</span></code> class contains detailed information about the vCenter
patch/update.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the vSphere update</p></li>
<li><p><strong>pending_update</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the given vSphere update
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.update.pending</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the vSphere update or patch</p></li>
<li><p><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Release date of the vSphere update or patch</p></li>
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType"title="com.vmware.vcenter.lcm.update_client.Pending.SeverityType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.SeverityType</span></code></a>) – Severity of the issues fixed in the vSphere update or patch</p></li>
<li><p><strong>build</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Build number of the vCenter Release</p></li>
<li><p><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType"title="com.vmware.vcenter.lcm.update_client.Pending.UpdateType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.UpdateType</span></code></a>) – Type of the Release based on the current vCenter version</p></li>
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.Category"title="com.vmware.vcenter.lcm.update_client.Pending.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.Category</span></code></a>) – Category of the release based on features bundled on top of
previous release</p></li>
<li><p><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to suggest a reboot after the release is applied</p></li>
<li><p><strong>execute_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – VAMI or ISO URL for update or upgrade execute phase redirection</p></li>
<li><p><strong>release_notes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of URI pointing to patch or update release notes</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ListResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">last_check_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">update_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">updates</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issues</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.ListResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.ListResult</span></code> class contains information about the pending
patch/updates for the given vCenter server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>last_check_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the software depo was last checked.</p></li>
<li><p><strong>update_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of pending updates
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if there are available updates</p></li>
<li><p><strong>upgrade_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of pending upgrades
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if there are available upgrades</p></li>
<li><p><strong>updates</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.Summary"title="com.vmware.vcenter.lcm.update_client.Pending.Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.Summary</span></code></a>) – List of pending update details</p></li>
<li><p><strong>issues</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications"title="com.vmware.vcenter.lcm_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Lists of issues encountered during pending updates retrieval.
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if any issues encountered.</p></li>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.lcm.update.pending'</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SeverityType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType"title="Permalink to this definition">¶</a></dt>
<p>Level of severity for applying a given patch or update.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SeverityType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CRITICAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SeverityType(string='CRITICAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType.CRITICAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities that can be exploited by an unauthenticated attacker from
the Internet or those that break the guest/host Operating System isolation.</p>
<codeclass="sig-name descname"><spanclass="pre">IMPORTANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SeverityType(string='IMPORTANT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType.IMPORTANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities that are not rated critical but whose exploitation results
in the complete compromise of confidentiality and/or integrity of user data
and/or processing resources through user assistance or by authenticated
<codeclass="sig-name descname"><spanclass="pre">LOW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SeverityType(string='LOW')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType.LOW"title="Permalink to this definition">¶</a></dt>
<dd><p>All other issues that may or maynot have a security impact. Vulnerabilities
where exploitation is believed to be extremely difficult, or where
successful exploitation would have minimal impact.</p>
<codeclass="sig-name descname"><spanclass="pre">MODERATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SeverityType(string='MODERATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType.MODERATE"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities where the ability to exploit is mitigated to a significant
degree by configuration or difficulty of exploitation, but in certain
deployment scenarios could still lead to the compromise of confidentiality,
integrity, or availability of user data and/or processing resources.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.Summary</span></code> class contains basic information about the vCenter
patch/update/upgrade</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>pending_update</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the given vSphere update
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm.update.pending</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the vSphere update or patch</p></li>
<li><p><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Release date of the vSphere update or patch</p></li>
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType"title="com.vmware.vcenter.lcm.update_client.Pending.SeverityType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.SeverityType</span></code></a>) – Severity of the issues fixed in the vSphere update or patch</p></li>
<li><p><strong>build</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Build number of the vCenter Release</p></li>
<li><p><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType"title="com.vmware.vcenter.lcm.update_client.Pending.UpdateType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.UpdateType</span></code></a>) – Type of the Release based on the current vCenter version</p></li>
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.Pending.Category"title="com.vmware.vcenter.lcm.update_client.Pending.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.Category</span></code></a>) – Category of the release based on features bundled on top of
previous release</p></li>
<li><p><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to suggest a reboot after the release is applied</p></li>
<li><p><strong>execute_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – VAMI or ISO URL for update or upgrade execute phase redirection</p></li>
<li><p><strong>release_notes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of URI pointing to patch or update release notes</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.UpdateType</span></code> class defines update type</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">PATCH</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpdateType(string='PATCH')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType.PATCH"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UPDATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpdateType(string='UPDATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType.UPDATE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UPGRADE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpdateType(string='UPGRADE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType.UPGRADE"title="Permalink to this definition">¶</a></dt>
<dd><p>Introduces new features, significantly changes product functionality</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets detailed update information.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A version identified the update
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.Pending.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists all available minor and major updates.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.update_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PrecheckReport</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PrecheckReport</span></code> class generates precheck report for a vCenter Server
instance against a target update version.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.lcm.report'</span></em><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Report</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">date_created</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">estimated_time_to_update</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issues</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">summary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.Report"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PrecheckReport.Report</span></code> class contains estimates of how long it will
take an update as well as a list of possible warnings and errors with
applying the update.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>date_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when this precheck report was generated</p></li>
<li><p><strong>estimated_time_to_update</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rough estimate of time to update vCenter Server in minutes.
This attribute will be None if the precheck failed.</p></li>
<li><p><strong>issues</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications"title="com.vmware.vcenter.lcm_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Lists of the issues and warnings
This attribute will be None if the precehck is successful.</p></li>
<li><p><strong>summary</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary"title="com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrecheckReport.ReportSummary</span></code></a>) – A summary of the report consist of count of warnings and errors
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReportSummary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">error_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">warning_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Summary</span></code> Class contains the summary of precheck report.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>error_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of errors detected by precheck process</p></li>
<li><p><strong>warning_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of warnings detected by precheck process</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Result</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">report</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">csv_report</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.Result"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">create_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.create_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a vCenter Server pre-update compatibility check report for the
pending update version. The report can be exported and downloaded in
CSV format.</p>
<p>The result of this operation can be queried by calling the
com.vmware.cis.Tasks#get method where <codeclass="docutils literal notranslate"><spanclass="pre">task</span></code> is the response of this
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Pending update version for which pre-update compatibility check
will be executed.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm.update_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm.update_client.StubFactory"title="Permalink to this definition">¶</a></dt>
