Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 10:50:00 -05:00
Code
8ed6ef5a71
vsphere-automation-sdk-python/vsphere/7.0.2.0/com.vmware.vcenter.lcm.html
shweta 3f9a1d21a8 7.0U2 MP1 release Docs 
Signed-off-by: Shweta Purohit <spurohit@vmware.com>
2021-05-12 16:45:26 +05:30

1765 lines
159 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.lcm package &mdash; vSphere Automation SDK for Python. 7.0.2.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.namespace_management package" href="com.vmware.vcenter.namespace_management.html" />
<link rel="prev" title="com.vmware.vcenter.hvc.links package" href="com.vmware.vcenter.hvc.links.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.lcm package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.lcm.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.lcm">
<span id="com-vmware-vcenter-lcm-package"></span><h1>com.vmware.vcenter.lcm package<a class="headerlink" href="#module-com.vmware.vcenter.lcm" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.lcm.common_client">
<span id="com-vmware-vcenter-lcm-common-client-module"></span><h2>com.vmware.vcenter.lcm.common_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm.common_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.upgrade</span></code> module provides classes for upgrading
vCenter Server to a newer version.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceDeployment">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceDeployment</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thin_disk_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ova_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceDeployment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceDeployment</span></code> class describes the new appliance deployment
configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>size</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize" title="com.vmware.vcenter.lcm.common_client.ApplianceSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceSize</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If <code class="docutils literal notranslate"><span class="pre">#ApplianceSize</span></code> is not provided, will use the size of the
source VCSA</p></li>
<li><p><strong>thin_disk_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>disk_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.StorageSize" title="com.vmware.vcenter.lcm.common_client.StorageSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageSize</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The disk size of the new vCenter appliance.
If <code class="docutils literal notranslate"><span class="pre">#StorageSize</span></code> is not provided, will use the diskSize of the
source VCSA.</p></li>
<li><p><strong>root_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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., ‘!’, ‘(‘, ‘\&#64;’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>ova_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.OvaInfo" title="com.vmware.vcenter.lcm.common_client.OvaInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvaInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This key describes the enabling option for the VMware’s Customer
Experience Improvement Program (CEIP).
If None, defaults to True</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceDeploymentConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceDeploymentConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">appliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceDeploymentConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceDeploymentConfig</span></code> class contains the new appliance
deployment configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>appliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.ApplianceDeployment" title="com.vmware.vcenter.lcm.common_client.ApplianceDeployment"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceDeployment</span></code></a>) – Description of the new appliance configuration.</p></li>
<li><p><strong>location</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.Location" title="com.vmware.vcenter.lcm.common_client.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Location</span></code></a>) – ESX or VC on which to deploy the appliance.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceSize</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceSize</span></code> class defines the size of the appliance (CPU and
memory) to be deployed.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize" title="com.vmware.vcenter.lcm.common_client.ApplianceSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceSize</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘large’,</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘medium’.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize.SMALL">
<code class="sig-name descname"><span class="pre">SMALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘small’.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize.TINY">
<code class="sig-name descname"><span class="pre">TINY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='TINY')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘tiny’.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.ApplianceSize.XLARGE">
<code class="sig-name descname"><span class="pre">XLARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='XLARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.ApplianceSize.XLARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘extra large’.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.Connection">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">Connection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Connection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Connection</span></code> class contains information for deployment location</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A username with administrative privileges on the ESX/VC host.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The password of the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Connection.username</span></code> on the ESX/VC host.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The port number for the ESX/VC.
If None, defaults to 443</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to True</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Thumbprint for SSL verification.
If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> if false, this field is not required</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.Esx">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">Esx</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">placement_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Esx" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Esx</span></code> class contains ESX configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>connection</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.Connection" title="com.vmware.vcenter.lcm.common_client.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>placement_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.EsxPlacementConfig" title="com.vmware.vcenter.lcm.common_client.EsxPlacementConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">EsxPlacementConfig</span></code></a>) – The location of the new version of the vCSA on the desired ESX.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.EsxPlacementConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">EsxPlacementConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.EsxPlacementConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EsxPlacementConfig</span></code> class contains configuration of ESX placement of
the target appliance.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The path to the resource pool on the ESX host in which the
appliance will be deployed.
Not applicable when not in resource pool</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.HashAlgorithm">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">HashAlgorithm</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HashAlgorithm</span></code> class defines the valid hash algorithms.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm" title="com.vmware.vcenter.lcm.common_client.HashAlgorithm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HashAlgorithm</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA256">
<code class="sig-name descname"><span class="pre">SHA256</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HashAlgorithm(string='SHA256')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA256" title="Permalink to this definition"></a></dt>
<dd><p>Hash algorithm: SHA-256</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA512">
<code class="sig-name descname"><span class="pre">SHA512</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HashAlgorithm(string='SHA512')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA512" title="Permalink to this definition"></a></dt>
<dd><p>Hash algorithm: SHA-512</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.Location">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">Location</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">esx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcenter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Location" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Location</span></code> class contains configuration of appliance location.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>esx</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.Esx" title="com.vmware.vcenter.lcm.common_client.Esx"><code class="xref py py-class docutils literal notranslate"><span class="pre">Esx</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">esx</span></code> and <code class="docutils literal notranslate"><span class="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.VCenter" title="com.vmware.vcenter.lcm.common_client.VCenter"><code class="xref py py-class docutils literal notranslate"><span class="pre">VCenter</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <code class="docutils literal notranslate"><span class="pre">esx</span></code> and <code class="docutils literal notranslate"><span class="pre">vcenter</span></code></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.OvaInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">OvaInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_hash</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hash_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.OvaInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvaInfo</span></code> class defines the OVA file location info.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The location of the OVA file for installation. It can be web URL or
absolute filepath i.e <a class="reference external" href="https://server.com/appliance.ova">https://server.com/appliance.ova</a> or
<a class="reference external" href="file://storage/appliance.ova">file://storage/appliance.ova</a></p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Hash to verify the SSL OVA location. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is false this
filed can be omitted. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and this field is
ommited a CA based validation will be used. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is
true and this field is provided will be used for SSL validation.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be used for SSL validation.</p></li>
<li><p><strong>hash_algorithm</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm" title="com.vmware.vcenter.lcm.common_client.HashAlgorithm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HashAlgorithm</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The hash algorithm (SHA256, SHA512) used to calculate the checksum.
If not specified the default checksum algorithm is
<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA256" title="com.vmware.vcenter.lcm.common_client.HashAlgorithm.SHA256"><code class="xref py py-attr docutils literal notranslate"><span class="pre">HashAlgorithm.SHA256</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.Question">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">Question</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_answer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Question" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question</span></code> class describes a item of information that must be
provided by the user in order to perform the update.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.common.dataitem</span></code>.</p></li>
<li><p><strong>text</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Label for the item</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the item</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.Question.InputType" title="com.vmware.vcenter.lcm.common_client.Question.InputType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.InputType</span></code></a>) – The type of the field.</p></li>
<li><p><strong>allowed_values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of allowed values
allowedValues If None any value is valid.</p></li>
<li><p><strong>default_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Default answer
defaultAnswer If None then there is no default answer, so an
explicit answer must be provided</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.Question.InputType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InputType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Question.InputType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question.InputType</span></code> class defines the supported field types for
questions.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">InputType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.Question.InputType.BOOLEAN">
<code class="sig-name descname"><span class="pre">BOOLEAN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">InputType(string='BOOLEAN')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Question.InputType.BOOLEAN" title="Permalink to this definition"></a></dt>
<dd><p>Yes/No,On/Off,Checkbox answer.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.Question.InputType.PASSWORD">
<code class="sig-name descname"><span class="pre">PASSWORD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">InputType(string='PASSWORD')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Question.InputType.PASSWORD" title="Permalink to this definition"></a></dt>
<dd><p>Password (masked) answer.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.Question.InputType.PLAIN_TEXT">
<code class="sig-name descname"><span class="pre">PLAIN_TEXT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">InputType(string='PLAIN_TEXT')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.Question.InputType.PLAIN_TEXT" title="Permalink to this definition"></a></dt>
<dd><p>Plain text answer.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.StorageSize">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">StorageSize</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.StorageSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StorageSize</span></code> class defines the storage size of the appliance to be
deployed.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.StorageSize" title="com.vmware.vcenter.lcm.common_client.StorageSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageSize</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.StorageSize.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.StorageSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Large storage</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.StorageSize.REGULAR">
<code class="sig-name descname"><span class="pre">REGULAR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageSize(string='REGULAR')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.StorageSize.REGULAR" title="Permalink to this definition"></a></dt>
<dd><p>Regular storage</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.common_client.StorageSize.XLARGE">
<code class="sig-name descname"><span class="pre">XLARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageSize(string='XLARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.StorageSize.XLARGE" title="Permalink to this definition"></a></dt>
<dd><p>Extra large storage</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.VCenter">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">VCenter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">placement_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.VCenter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VCenter</span></code> class contains configuration of the VC that hosts/will host
an appliance.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>connection</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.Connection" title="com.vmware.vcenter.lcm.common_client.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>placement_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.common_client.VcPlacementConfig" title="com.vmware.vcenter.lcm.common_client.VcPlacementConfig"><code class="xref py py-class docutils literal notranslate"><span class="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.
‘host_path’: ‘/MyDataCenter/host/MyCluster/10.20.30.40’,
‘datastore_name’: ‘Your Datastore’. 5. To install a new appliance
to a specific resource pool, provide the ‘resource_pool_path’, and
the ‘datastore_name’, e.g. ‘resource_pool_path’: ‘/Your Datacenter
Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource
Pool’, ‘datastore_name’: ‘Your Datastore’. 6. To place a new
appliance to a virtual machine Folder, provide the
‘vm_folder_path’, e.g. vm_folder_path’: ‘VM Folder 0/VM Folder1’.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.common_client.VcPlacementConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.common_client.</span></code><code class="sig-name descname"><span class="pre">VcPlacementConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_folder_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastore_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastore_cluster_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.common_client.VcPlacementConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VcPlacementConfig</span></code> class contains configuration of VC placement of
the target appliance.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_folder_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Aboslute path of the VM folder. VM folder must be visible by the
Data Center of the compute
resourceFormat:/{dc}/{vm_folder1}/{vm_folder2}e.g.:’/DCenter/VM
Folder 0/VM Folder1’.
Mutually exclusive between {\&#64;vm_folder_path},
<code class="docutils literal notranslate"><span class="pre">#resource_pool_path</span></code>, <code class="docutils literal notranslate"><span class="pre">#cluster_path</span></code>, and <code class="docutils literal notranslate"><span class="pre">#host_path</span></code></p></li>
<li><p><strong>resource_pool_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path to resource pool. Format: /{datacenter
folder}/{datacenter name}/host/{host
name}/{cluster_name}/Resources/{resource pool}. e.g: Your
Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your
Resource Pool
Mutually exclusive between {\&#64;vm_folder_path},
<code class="docutils literal notranslate"><span class="pre">#resource_pool_path</span></code>, <code class="docutils literal notranslate"><span class="pre">#cluster_path</span></code>, and <code class="docutils literal notranslate"><span class="pre">#host_path</span></code></p></li>
<li><p><strong>cluster_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path to the cluster. Format: /{datacenter
folder}/{datacenter name}/host/{cluster_name}. e.g: /Your
Datacenter Folder/Your Datacenter/host/Your Cluster
Mutually exclusive between {\&#64;vm_folder_path},
<code class="docutils literal notranslate"><span class="pre">#resource_pool_path</span></code>, <code class="docutils literal notranslate"><span class="pre">#cluster_path</span></code>, and <code class="docutils literal notranslate"><span class="pre">#host_path</span></code></p></li>
<li><p><strong>host_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of the ESX host (FQDN/IP) in the vCenter inventory
tree.
Mutually exclusive between {\&#64;vm_folder_path},
<code class="docutils literal notranslate"><span class="pre">#resource_pool_path</span></code>, <code class="docutils literal notranslate"><span class="pre">#cluster_path</span></code>, and <code class="docutils literal notranslate"><span class="pre">#host_path</span></code></p></li>
<li><p><strong>datastore_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">#datastore_name</span></code> and
<code class="docutils literal notranslate"><span class="pre">#datastore_cluster_name</span></code></p></li>
<li><p><strong>datastore_cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">#datastore_name</span></code> and
<code class="docutils literal notranslate"><span class="pre">#datastore_cluster_name</span></code></p></li>
<li><p><strong>network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the network. e.g. VM Network</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.lcm.discovery_client">
<span id="com-vmware-vcenter-lcm-discovery-client-module"></span><h2>com.vmware.vcenter.lcm.discovery_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm.discovery_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.discovery_client</span></code> module provides classes for
discovering products registered with vCenter Server and interoperability
between those products and vCenter Server.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><code class="sig-name descname"><span class="pre">AssociatedProducts</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AssociatedProducts.CreateSpec</span></code> class is the specification used for
the product creation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>product_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the product.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current product version.</p></li>
<li><p><strong>deployments</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of hostname/IPs of the instances of the VMware products
deployed in the environment.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.lcm.product'</span></em><a class="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>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deployments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AssociatedProducts.UpdateSpec</span></code> class is the specification for the
product update.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>deployments</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of hostname/IPs of the instances of the VMware products
deployed in the environment.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="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
must be taken from the product catalog API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.CreateSpec" title="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssociatedProducts.CreateSpec</span></code></a>) – Info creation specification.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the newly-added product.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.product</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if this version is already added</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the spec argument is not allowed</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An id of the product to be removed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.product</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no record associated with <code class="docutils literal notranslate"><span class="pre">product</span></code> in the system
database.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An identifier of the product to be modified.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.product</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.Product" title="com.vmware.vcenter.lcm.discovery_client.Product"><code class="xref py py-class docutils literal notranslate"><span class="pre">Product</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Product details.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no record associated with <code class="docutils literal notranslate"><span class="pre">product</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
manually through the API.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.list" title="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.Product" title="com.vmware.vcenter.lcm.discovery_client.Product"><code class="xref py py-class docutils literal notranslate"><span class="pre">Product</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of all the registered products with vCenter.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An id of the product to be modified.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.product</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.UpdateSpec" title="com.vmware.vcenter.lcm.discovery_client.AssociatedProducts.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssociatedProducts.UpdateSpec</span></code></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the spec argument is not allowed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no record associated with <code class="docutils literal notranslate"><span class="pre">product</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><code class="sig-name descname"><span class="pre">InteropReport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReleaseInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InteropReport.ReleaseInfo</span></code> class contains a product release
information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the release.</p></li>
<li><p><strong>note</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A link to the release notes of the release.
None if the release notes are not available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.Report">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Report</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">products</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Report" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InteropReport.Report</span></code> class contains the interoperability report
between the target product and the other registered products in the vCenter
Server instance.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>date_created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the report is created.</p></li>
<li><p><strong>target_product</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.Product" title="com.vmware.vcenter.lcm.discovery_client.Product"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow" title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications" title="com.vmware.vcenter.lcm_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists of issues encountered during report creation.
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if any issues encountered.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary" title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteropReport.ReportSummary</span></code></a>) – A summary of the interoperability matrix.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReportRow</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportRow" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InteropReport.ReportRow</span></code> class contains the interoperability between
a given product and the target product.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>product</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.Product" title="com.vmware.vcenter.lcm.discovery_client.Product"><code class="xref py py-class docutils literal notranslate"><span class="pre">Product</span></code></a>) – The product to compare to the target product.</p></li>
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Defines whether the product is compatible against the target
product.</p></li>
<li><p><strong>compatible_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo" title="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReleaseInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteropReport.ReleaseInfo</span></code></a>) – A list of compatible releases of the product with the target
product.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReportSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatible_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.ReportSummary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InteropReport.ReportSummary</span></code> class contains a summary of the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">InteropReport.Report.products</span></code>. It consists of the count of
compatible and incompatible products to the target product.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>compatible_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of compatible products.</p></li>
<li><p><strong>incompatible_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of incompatible products.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.Result">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Result</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csv_report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Result" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InteropReport.Result</span></code> class contains the result of interoperability
report creation operation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>report</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Report" title="com.vmware.vcenter.lcm.discovery_client.InteropReport.Report"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteropReport.Report</span></code></a>) – The interoperability report.</p></li>
<li><p><strong>csv_report</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The identifier of CSV formatted interopability report.</p>
<p>com.vmware.vcenter.lcm.report.Report#get provides location where
the CSV report can be downloaded from based on the <code class="docutils literal notranslate"><span class="pre">csvReport</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.report</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.report</span></code>.
None in case of <code class="docutils literal notranslate"><span class="pre">errors</span></code> reported in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">InteropReport.Report.issues</span></code>.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Configuration of report generation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>target_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The vCenter Server version.</p>
<p>It is used for checking against the other products registered with
that instance of vCenter Server.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.InteropReport.create_task">
<code class="sig-name descname"><span class="pre">create_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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 <code class="docutils literal notranslate"><span class="pre">task</span></code> is the response of this
operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec" title="com.vmware.vcenter.lcm.discovery_client.InteropReport.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteropReport.Spec</span></code></a> or <code class="docutils literal notranslate"><span class="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>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.Product">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><code class="sig-name descname"><span class="pre">Product</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">installed_product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.Product" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<ul class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>installed_product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">PRODUCT</span></code>.</p>
</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A public official product name.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current product version.</p></li>
<li><p><strong>target_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Future version of the product after upgrade.
<code class="docutils literal notranslate"><span class="pre">targetVersion</span></code> may not be applicable.</p></li>
<li><p><strong>deployments</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.ProductCatalog">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><code class="sig-name descname"><span class="pre">ProductCatalog</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProductCatalog</span></code> class provides information which VMware products can
be associated with vCenter Server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.ProductCatalog.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">versions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProductCatalog.Summary</span></code> class contains information about each VMware
product and its corresponding versions that can be associated with vCenter
Server.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A product name that the customer is aware of.</p></li>
<li><p><strong>versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of versions the customer can select from.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.discovery_client.ProductCatalog.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
vCenter Server.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog.list" title="com.vmware.vcenter.lcm.discovery_client.ProductCatalog.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.lcm.discovery_client.ProductCatalog.Summary" title="com.vmware.vcenter.lcm.discovery_client.ProductCatalog.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProductCatalog.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of all the VMware products which can be associated with
vCenter Server</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.discovery_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.discovery_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.discovery_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.lcm.update_client">
<span id="com-vmware-vcenter-lcm-update-client-module"></span><h2>com.vmware.vcenter.lcm.update_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm.update_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.update_client</span></code> module provides classes for
updating vCenter Server to a newer version.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.update_client.</span></code><code class="sig-name descname"><span class="pre">Pending</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending</span></code> class provides method for listing pending minor or major
updates of vCenter Server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Category">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Category</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Category" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.Category</span></code> class defines the type of payload this release has
on top of previous release</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Category.FIX">
<code class="sig-name descname"><span class="pre">FIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='FIX')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Category.FIX" title="Permalink to this definition"></a></dt>
<dd><p>Fixes bugs/vulnerabilities, doesn’t change functionality</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Category.SECURITY">
<code class="sig-name descname"><span class="pre">SECURITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='SECURITY')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Category.SECURITY" title="Permalink to this definition"></a></dt>
<dd><p>Fixes vulnerabilities, doesn’t change functionality</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Category.UPDATE">
<code class="sig-name descname"><span class="pre">UPDATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='UPDATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Category.UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>Changes product functionality</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Category.UPGRADE">
<code class="sig-name descname"><span class="pre">UPGRADE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='UPGRADE')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pending_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">severity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reboot_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execute_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.Info</span></code> class contains detailed information about the vCenter
patch/update.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the vSphere update</p></li>
<li><p><strong>pending_update</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.update.pending</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the vSphere update or patch</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the vSphere update or patch</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType" title="com.vmware.vcenter.lcm.update_client.Pending.SeverityType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.SeverityType</span></code></a>) – Severity of the issues fixed in the vSphere update or patch</p></li>
<li><p><strong>build</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Build number of the vCenter Release</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType" title="com.vmware.vcenter.lcm.update_client.Pending.UpdateType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.UpdateType</span></code></a>) – Type of the Release based on the current vCenter version</p></li>
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.Category" title="com.vmware.vcenter.lcm.update_client.Pending.Category"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to suggest a reboot after the release is applied</p></li>
<li><p><strong>execute_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – VAMI or ISO URL for update or upgrade execute phase redirection</p></li>
<li><p><strong>release_notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of URI pointing to patch or update release notes</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.ListResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ListResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">last_check_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.ListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.ListResult</span></code> class contains information about the pending
patch/updates for the given vCenter server.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>last_check_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the software depo was last checked.</p></li>
<li><p><strong>update_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of pending updates
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there are available updates</p></li>
<li><p><strong>upgrade_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of pending upgrades
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there are available upgrades</p></li>
<li><p><strong>updates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.Summary" title="com.vmware.vcenter.lcm.update_client.Pending.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.Summary</span></code></a>) – List of pending update details</p></li>
<li><p><strong>issues</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications" title="com.vmware.vcenter.lcm_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists of issues encountered during pending updates retrieval.
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if any issues encountered.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.lcm.update.pending'</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for pending update</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.SeverityType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SeverityType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Level of severity for applying a given patch or update.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SeverityType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.SeverityType.CRITICAL">
<code class="sig-name descname"><span class="pre">CRITICAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SeverityType(string='CRITICAL')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.SeverityType.IMPORTANT">
<code class="sig-name descname"><span class="pre">IMPORTANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SeverityType(string='IMPORTANT')</span></em><a class="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
attackers.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.SeverityType.LOW">
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SeverityType(string='LOW')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.SeverityType.MODERATE">
<code class="sig-name descname"><span class="pre">MODERATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SeverityType(string='MODERATE')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pending_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">severity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reboot_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execute_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.Summary</span></code> class contains basic information about the vCenter
patch/update/upgrade</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pending_update</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.update.pending</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the vSphere update or patch</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the vSphere update or patch</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.SeverityType" title="com.vmware.vcenter.lcm.update_client.Pending.SeverityType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.SeverityType</span></code></a>) – Severity of the issues fixed in the vSphere update or patch</p></li>
<li><p><strong>build</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Build number of the vCenter Release</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType" title="com.vmware.vcenter.lcm.update_client.Pending.UpdateType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.UpdateType</span></code></a>) – Type of the Release based on the current vCenter version</p></li>
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.Category" title="com.vmware.vcenter.lcm.update_client.Pending.Category"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to suggest a reboot after the release is applied</p></li>
<li><p><strong>execute_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – VAMI or ISO URL for update or upgrade execute phase redirection</p></li>
<li><p><strong>release_notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of URI pointing to patch or update release notes</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.UpdateType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.UpdateType</span></code> class defines update type</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.UpdateType.PATCH">
<code class="sig-name descname"><span class="pre">PATCH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateType(string='PATCH')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType.PATCH" title="Permalink to this definition"></a></dt>
<dd><p>Fixes bugs/vulnerabilities, doesn’t change functionality</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.UpdateType.UPDATE">
<code class="sig-name descname"><span class="pre">UPDATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateType(string='UPDATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.UpdateType.UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>Changes product functionality</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.UpdateType.UPGRADE">
<code class="sig-name descname"><span class="pre">UPGRADE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateType(string='UPGRADE')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.Pending.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets detailed update information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A version identified the update
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.update.pending</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.Info" title="com.vmware.vcenter.lcm.update_client.Pending.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A detailed information about the particular vCenter patch/update</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if there is no pending update assosiated with the <code class="docutils literal notranslate"><span class="pre">version</span></code> in
the system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is some unknown internal error. The accompanying error
message will give more details about the error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.update_client.Pending.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.Pending.ListResult" title="com.vmware.vcenter.lcm.update_client.Pending.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.ListResult</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information about the pending patch/updates for the given vCenter
server</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is some unknown internal error. The accompanying error
message will give more details about the error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.update_client.</span></code><code class="sig-name descname"><span class="pre">PrecheckReport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PrecheckReport</span></code> class generates precheck report for a vCenter Server
instance against a target update version.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.lcm.report'</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for precheck report</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport.Report">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Report</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">estimated_time_to_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.Report" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>date_created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this precheck report was generated</p></li>
<li><p><strong>estimated_time_to_update</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.lcm_client.Notifications" title="com.vmware.vcenter.lcm_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary" title="com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrecheckReport.ReportSummary</span></code></a>) – A summary of the report consist of count of warnings and errors
returned by running the precheck.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReportSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warning_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.ReportSummary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary</span></code> Class contains the summary of precheck report.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of errors detected by precheck process</p></li>
<li><p><strong>warning_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of warnings detected by precheck process</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport.Result">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Result</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csv_report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.Result" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PrecheckReport.Result</span></code> class contains the precheck report and a link
to download the CSV report.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>report</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.update_client.PrecheckReport.Report" title="com.vmware.vcenter.lcm.update_client.PrecheckReport.Report"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrecheckReport.Report</span></code></a>) – The report generated by running the precheck.</p></li>
<li><p><strong>csv_report</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of CSV formatted precheck report.
com.vmware.vcenter.lcm.report#get provides location where the CSV
report can be downloaded from based on the <code class="docutils literal notranslate"><span class="pre">csvReport</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.report</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.report</span></code>.
None in case of <code class="docutils literal notranslate"><span class="pre">errors</span></code> reported in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PrecheckReport.Report.issues</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm.update_client.PrecheckReport.create_task">
<code class="sig-name descname"><span class="pre">create_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="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 <code class="docutils literal notranslate"><span class="pre">task</span></code> is the response of this
operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.update.pending</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if there is no pending update assosiated with the <code class="docutils literal notranslate"><span class="pre">version</span></code> in
the system.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a precheck is already in progress.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is some unknown internal error. The accompanying error
message will give more details about the error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm.update_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.update_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.update_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.namespace_management.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespace_management package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.hvc.links package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink