Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code
0c2294f46c
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.lcm.deployment.html
bhagatp10 44eb68437b
Updated VC docs for v8.0.3.0 (#424) 
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>

Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 17:44:27 +05:30

1309 lines
141 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.lcm.deployment package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script 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.lcm package" href="com.vmware.vcenter.lcm.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">
8.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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.esx_client">com.vmware.esx_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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.lcm.html">com.vmware.vcenter.lcm package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.lcm.deployment package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.lcm.deployment.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">
<section id="module-com.vmware.vcenter.lcm.deployment">
<span id="com-vmware-vcenter-lcm-deployment-package"></span><h1>com.vmware.vcenter.lcm.deployment package<a class="headerlink" href="#module-com.vmware.vcenter.lcm.deployment" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.vcenter.lcm.deployment.common_client">
<span id="com-vmware-vcenter-lcm-deployment-common-client-module"></span><h2>com.vmware.vcenter.lcm.deployment.common_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm.deployment.common_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client</span></code> module provides common
classes for install/upgrade of a vCenter Server.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.AllocateResource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">AllocateResource</span></span><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.deployment.common_client.AllocateResource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AllocateResource</span></code> class defines when to allocate resource to the
target VM. See <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo" title="com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>. This enumeration was added
in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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.deployment.common_client.AllocateResource" title="com.vmware.vcenter.lcm.deployment.common_client.AllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">AllocateResource</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.AllocateResource.ON_DEPLOYMENT">
<span class="sig-name descname"><span class="pre">ON_DEPLOYMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">AllocateResource(string='ON_DEPLOYMENT')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.AllocateResource.ON_DEPLOYMENT" title="Permalink to this definition"></a></dt>
<dd><p>On deployment of a new VM allocate the resource. This class attribute was
added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.AllocateResource.ON_SUCCESSFUL_UPGRADE">
<span class="sig-name descname"><span class="pre">ON_SUCCESSFUL_UPGRADE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">AllocateResource(string='ON_SUCCESSFUL_UPGRADE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.AllocateResource.ON_SUCCESSFUL_UPGRADE" title="Permalink to this definition"></a></dt>
<dd><p>On successful upgrade of the VC allocate the resource to the VM deployed as
part of the upgrade. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceDeployment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">ApplianceDeployment</span></span><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">network_settings</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>, <em class="sig-param"><span class="n"><span class="pre">cpu_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_allocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceDeployment</span></code> class describes the new appliance deployment
configuration. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></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 VM name of the appliance to deploy. This attribute was added in
vSphere API 8.0.3.0.</p></li>
<li><p><strong>size</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize" title="com.vmware.vcenter.lcm.deployment.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. This attribute was
added in vSphere API 8.0.3.0.
If <code class="docutils literal notranslate"><span class="pre">size</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. This
attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>disk_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.StorageSize" title="com.vmware.vcenter.lcm.deployment.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. This attribute was
added in vSphere API 8.0.3.0.
If <code class="docutils literal notranslate"><span class="pre">diskSize</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>) – <p>A root password to be used for that appliance. During migration
upgrade it is only temporary passwords. It must conform to the
following requirements:</p>
<ul>
<li><p>At least 8 characters.</p></li>
<li><p>No more than 20 characters.</p></li>
<li><p>At least 1 uppercase character.</p></li>
<li><p>At least 1 lowercase character.</p></li>
<li><p>At least 1 number.</p></li>
<li><p>At least 1 special character (e.g., ‘!’, ‘(’, ‘\&#64;’, etc.).</p></li>
<li><p>Only visible A-Z, a-z, 0-9 and punctuation (spaces are not
allowed)</p></li>
</ul>
<p>. This attribute was added in vSphere API 8.0.3.0.</p>
</p></li>
<li><p><strong>network_settings</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network" title="com.vmware.vcenter.lcm.deployment.common_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The network settings of the appliance to be deployed. This
attribute was added in vSphere API 8.0.3.0.
If None the appliance will be deployed with an automatically
selected link-local address.</p></li>
<li><p><strong>ova_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.OvaInfo" title="com.vmware.vcenter.lcm.deployment.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>) – Custom location of the OVA for deployment. This attribute was added
in vSphere API 8.0.3.0.
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). This attribute was added in
vSphere API 8.0.3.0.
If None, defaults to True</p></li>
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo" title="com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation information of CPU. This attribute was added in
vSphere API 8.0.3.0.
If None will deploy the appliance with no cpu reservation.</p></li>
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo" title="com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation information of Memory. This attribute was added
in vSphere API 8.0.3.0.
If None will deploy the appliance with no memory reservation.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceDeploymentConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">ApplianceDeploymentConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_container</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">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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceDeploymentConfig</span></code> class contains the new appliance
deployment configuration. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_container</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Connection" title="com.vmware.vcenter.lcm.deployment.common_client.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A connection to container, which hosts the source appliance. This
connection information is required for automatically extracting and
preserving VM configuration during deployment, e.g. Virtual
Ethernet Cards. If either the current vCenter is self managed or
the VM configuration is not necessary to be preserved during
deployment this field might be omitted. This attribute was added in
vSphere API 8.0.3.0.
Not required if the current VCenter is self managed. Otherwise if
not set VM configuration won’t be preserved.</p></li>
<li><p><strong>appliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceDeployment" title="com.vmware.vcenter.lcm.deployment.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. This attribute was
added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>location</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Location" title="com.vmware.vcenter.lcm.deployment.common_client.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Location</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ESX or VC on which to deploy the appliance. This attribute was
added in vSphere API 8.0.3.0.
If None the target appliance will be deployed on the same location
as current vCenter. If current vCenter is not self managed and
source container is not specified, upgrade initialization will
fail.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">ApplianceSize</span></span><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.deployment.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">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. This enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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.deployment.common_client.ApplianceSize" title="com.vmware.vcenter.lcm.deployment.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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.LARGE">
<span class="sig-name descname"><span class="pre">LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplianceSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘large’,. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.MEDIUM">
<span class="sig-name descname"><span class="pre">MEDIUM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplianceSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘medium’. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.SMALL">
<span class="sig-name descname"><span class="pre">SMALL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplianceSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘small’. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.TINY">
<span class="sig-name descname"><span class="pre">TINY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplianceSize(string='TINY')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘tiny’. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.XLARGE">
<span class="sig-name descname"><span class="pre">XLARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplianceSize(string='XLARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize.XLARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of ‘extra large’. This class attribute was added in vSphere
API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Connection">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">Connection</span></span><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">certificate</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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Connection</span></code> class contains information used to connect to a vCenter
or ESXi. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></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. This attribute was added in vSphere API 8.0.3.0.</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. This
attribute was added in vSphere API 8.0.3.0.</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.
This attribute was added in vSphere API 8.0.3.0.</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. This attribute was added in vSphere
API 8.0.3.0.
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. This
attribute was added in vSphere API 8.0.3.0.
If None, defaults to True</p></li>
<li><p><strong>certificate</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>) – Certificate to verify the target host location. The value should be
a single x509 certificate encoded in PEM format. Only 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. This attribute was added in vSphere API 8.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be used for SSL validation.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Esx">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">Esx</span></span><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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Esx</span></code> class contains ESX configuration that should be used for
deployment. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>connection</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Connection" title="com.vmware.vcenter.lcm.deployment.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. This attribute was added
in vSphere API 8.0.3.0.</p></li>
<li><p><strong>placement_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.EsxPlacementConfig" title="com.vmware.vcenter.lcm.deployment.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.
This attribute was added in vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.EsxPlacementConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">EsxPlacementConfig</span></span><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.deployment.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">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. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></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. This attribute was added in vSphere API 8.0.3.0.</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. This
attribute was added in vSphere API 8.0.3.0.
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. This attribute was added in vSphere API
8.0.3.0.
Not applicable when not in resource pool</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">HashAlgorithm</span></span><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.deployment.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">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HashAlgorithm</span></code> class defines the valid hash algorithms. This
enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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.deployment.common_client.HashAlgorithm" title="com.vmware.vcenter.lcm.deployment.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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA256">
<span class="sig-name descname"><span class="pre">SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SHA256')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA256" title="Permalink to this definition"></a></dt>
<dd><p>Hash algorithm: SHA-256. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA512">
<span class="sig-name descname"><span class="pre">SHA512</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SHA512')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA512" title="Permalink to this definition"></a></dt>
<dd><p>Hash algorithm: SHA-512. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Location">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">Location</span></span><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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Location</span></code> class contains configuration of appliance location. This
class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>esx</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Esx" title="com.vmware.vcenter.lcm.deployment.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. This attribute was added in vSphere API 8.0.3.0.
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.deployment.common_client.VCenter" title="com.vmware.vcenter.lcm.deployment.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. This attribute was added in vSphere API 8.0.3.0.
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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">Network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_family</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">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">ip</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">dns_servers</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">prefix</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">gateway</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">hostname</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.deployment.common_client.Network" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Network</span></code> class defines the network configuration. This class was
added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ip_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.IpType" title="com.vmware.vcenter.lcm.deployment.common_client.Network.IpType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.IpType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Network IP address family. This attribute was added in vSphere API
8.0.3.0.
If None defaults to IPv4</p></li>
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode" title="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.NetworkMode</span></code></a>) – Network mode. This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Network IP address. Required for static mode only. This attribute
was added in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC" title="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>dns_servers</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>) – A comma-separated list of IP addresses of DNS servers.Required for
static mode only. A JSON array such as [“1.2.3.4”, “127.0.0.1”].
The DNS servers must be reachable from the source appliance and
only the first two will be used. This attribute was added in
vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC" title="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Network prefix length. Required for static mode only. This is the
number of bits set in the subnet mask; for instance, if the subnet
mask is 255.255.255.0, there are 24 bits in the binary version of
the subnet mask, so the prefix length is 24. If used, the values
must be in the inclusive range of 0 to 32 for IPv4 and 0 to 128 for
IPv6. This attribute was added in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC" title="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Gateway of the network. Required for static mode only. This
attribute was added in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC" title="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>hostname</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>) – Primary network identity. Can be either an IP address or a fully
qualified domain name(FQDN). This attribute was added in vSphere
API 8.0.3.0.
hostname may not be applicable</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.IpType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">IpType</span></span><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.deployment.common_client.Network.IpType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Network IP address family. This enumeration was added in vSphere API
8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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">IpType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.IpType.IPV4">
<span class="sig-name descname"><span class="pre">IPV4</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">IpType(string='IPV4')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.IpType.IPV4" title="Permalink to this definition"></a></dt>
<dd><p>IPv4 Type of IP address. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.IpType.IPV6">
<span class="sig-name descname"><span class="pre">IPV6</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">IpType(string='IPV6')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.IpType.IPV6" title="Permalink to this definition"></a></dt>
<dd><p>IPv6 Type of IP address. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NetworkMode</span></span><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.deployment.common_client.Network.NetworkMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Network mode. This enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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">NetworkMode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.DHCP">
<span class="sig-name descname"><span class="pre">DHCP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">NetworkMode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>DHCP mode. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC">
<span class="sig-name descname"><span class="pre">STATIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">NetworkMode(string='STATIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Network.NetworkMode.STATIC" title="Permalink to this definition"></a></dt>
<dd><p>Static IP mode. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.OvaInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">OvaInfo</span></span><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">ova_checksum</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_checksum_algorithm</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">certificate</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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvaInfo</span></code> class defines the OVA file location info to be used by the
lifecycle service. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></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>. This attribute was added in vSphere
API 8.0.3.0.</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. This attribute was added in vSphere API 8.0.3.0.
If None defaults to True</p></li>
<li><p><strong>ova_checksum</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>) – Checksum to validate the OVA file. This attribute was added in
vSphere API 8.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be used for checksum validation of the ova
file on the vCenter.</p></li>
<li><p><strong>ova_checksum_algorithm</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm" title="com.vmware.vcenter.lcm.deployment.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.
This attribute was added in vSphere API 8.0.3.0.
If not specified the default checksum algorithm is
<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA256" title="com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm.SHA256"><code class="xref py py-attr docutils literal notranslate"><span class="pre">HashAlgorithm.SHA256</span></code></a>.</p></li>
<li><p><strong>certificate</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>Certificate to verify the SSL OVA location. The value should be a
single x509 certificate encoded in PEM format.</p>
<ul>
<li><p>If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and this field is omitted. a CA based
validation will be used.</p></li>
<li><p>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.</p></li>
</ul>
<p>. This attribute was added in vSphere API 8.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be used for SSL validation.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Question">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">Question</span></span><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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question</span></code> class describes a item of additional information that must
be provided in order to perform the upgrade. This class was added in
vSphere API 8.0.3.0.</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<span class="colon">:</span></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. This attribute was added in vSphere API
8.0.3.0.
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.deployment.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.deployment.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. This attribute was added in vSphere API
8.0.3.0.</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. This attribute was added in vSphere API
8.0.3.0.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Question.InputType" title="com.vmware.vcenter.lcm.deployment.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. This attribute was added in vSphere API
8.0.3.0.</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. This attribute was added in vSphere API
8.0.3.0.
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. This attribute was added in vSphere API 8.0.3.0.
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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Question.InputType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InputType</span></span><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.deployment.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">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. This enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.BOOLEAN">
<span class="sig-name descname"><span class="pre">BOOLEAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">InputType(string='BOOLEAN')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.BOOLEAN" title="Permalink to this definition"></a></dt>
<dd><p>Yes/No,On/Off,Checkbox answer. This class attribute was added in vSphere
API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.PASSWORD">
<span class="sig-name descname"><span class="pre">PASSWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">InputType(string='PASSWORD')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.PASSWORD" title="Permalink to this definition"></a></dt>
<dd><p>Password (masked) answer. This class attribute was added in vSphere API
8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.PLAIN_TEXT">
<span class="sig-name descname"><span class="pre">PLAIN_TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">InputType(string='PLAIN_TEXT')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.Question.InputType.PLAIN_TEXT" title="Permalink to this definition"></a></dt>
<dd><p>Plain text answer. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">ResourceAllocationInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allocate</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.deployment.common_client.ResourceAllocationInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code> class contains resource allocation
information for a VM. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Amount of resource that is guaranteed available to the virtual
machine. Reserved resources are not wasted if they are not used. If
the utilization is less than the reservation, the resources can be
utilized by other running virtual machines. Units are MB for
memory, and MHz for CPU. This attribute was added in vSphere API
8.0.3.0.</p></li>
<li><p><strong>allocate</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.AllocateResource" title="com.vmware.vcenter.lcm.deployment.common_client.AllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">AllocateResource</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.3.0.
If None will allocate resource at VM deployment.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StoragePolicySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">StoragePolicySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</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.deployment.common_client.StoragePolicySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StoragePolicySpec</span></code> class contains information about the storage
policy to be associated with a virtual machine object. This class was added
in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy which should be associated with
the virtual machine. This attribute was added in vSphere API
8.0.3.0.
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.StoragePolicy</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.StoragePolicy</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StorageSize">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">StorageSize</span></span><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.deployment.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">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. This enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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.deployment.common_client.StorageSize" title="com.vmware.vcenter.lcm.deployment.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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StorageSize.LARGE">
<span class="sig-name descname"><span class="pre">LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">StorageSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.StorageSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Large storage. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StorageSize.REGULAR">
<span class="sig-name descname"><span class="pre">REGULAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">StorageSize(string='REGULAR')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.StorageSize.REGULAR" title="Permalink to this definition"></a></dt>
<dd><p>Regular storage. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StorageSize.XLARGE">
<span class="sig-name descname"><span class="pre">XLARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">StorageSize(string='XLARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.common_client.StorageSize.XLARGE" title="Permalink to this definition"></a></dt>
<dd><p>Extra large storage. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.deployment.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">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.VCenter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">VCenter</span></span><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.deployment.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">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VCenter</span></code> class contains VC configuration that should be used for
deployment. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>connection</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.Connection" title="com.vmware.vcenter.lcm.deployment.common_client.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The configuration to connect to a VCenter. This attribute was added
in vSphere API 8.0.3.0.
If None the target appliance will be deployed on the location
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">VCenter.placement_config</span></code> on the current
vCenter.</p></li>
<li><p><strong>placement_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.common_client.VcPlacementConfig" title="com.vmware.vcenter.lcm.deployment.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’..
This attribute was added in vSphere API 8.0.3.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.common_client.VcPlacementConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.common_client.</span></span><span class="sig-name descname"><span class="pre">VcPlacementConfig</span></span><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.deployment.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">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. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></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>) – Absolute 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’. This attribute was added in vSphere API
8.0.3.0.
If None the default VM folder of the Datacenter 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>) – 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. This attribute was added in vSphere API 8.0.3.0.
Mutually exclusive between <code class="docutils literal notranslate"><span class="pre">resourcePoolPath</span></code>, <code class="docutils literal notranslate"><span class="pre">clusterPath</span></code>,
and <code class="docutils literal notranslate"><span class="pre">hostPath</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. This attribute
was added in vSphere API 8.0.3.0.
Mutually exclusive between <code class="docutils literal notranslate"><span class="pre">resourcePoolPath</span></code>, <code class="docutils literal notranslate"><span class="pre">clusterPath</span></code>,
and <code class="docutils literal notranslate"><span class="pre">hostPath</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. This attribute was added in vSphere API 8.0.3.0.
Mutually exclusive between <code class="docutils literal notranslate"><span class="pre">resourcePoolPath</span></code>, <code class="docutils literal notranslate"><span class="pre">clusterPath</span></code>,
and <code class="docutils literal notranslate"><span class="pre">hostPath</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. This attribute was added in
vSphere API 8.0.3.0.
Mutually exclusive between <code class="docutils literal notranslate"><span class="pre">datastoreName</span></code> and
<code class="docutils literal notranslate"><span class="pre">datastoreClusterName</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. This attribute was added in vSphere API 8.0.3.0.
Mutually exclusive between <code class="docutils literal notranslate"><span class="pre">datastoreName</span></code> and
<code class="docutils literal notranslate"><span class="pre">datastoreClusterName</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the network. e.g. VM Network. This attribute was added in
vSphere API 8.0.3.0.
If None the target appliance will be deployed on the same network
as current vCenter. If current vCenter is not self managed and
source container is not specified, upgrade initialization will
fail.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.lcm.deployment.migration_upgrade_client">
<span id="com-vmware-vcenter-lcm-deployment-migration-upgrade-client-module"></span><h2>com.vmware.vcenter.lcm.deployment.migration_upgrade_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm.deployment.migration_upgrade_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.deployment.migration_upgrade_client</span></code> module
provides classes for executing migration-based operations.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.migration_upgrade_client.</span></span><span class="sig-name descname"><span class="pre">Status</span></span><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.deployment.migration_upgrade_client.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class provides methods to retrieve the status information
about the vCenter Appliance upgrade. This class was added in vSphere API
8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subtasks</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">subtask_order</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">progress</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">notifications</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_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">last_update_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">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">service</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">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</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</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">status</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">cancelable</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">error</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">start_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">end_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">user</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.deployment.migration_upgrade_client.Status.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Status.Info</span></code> class contains attributes to describe the state of the
appliance. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subtasks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Task" title="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.Task</span></code></a>) – The map of the deployment subtasks and their status information.
This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>subtask_order</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>) – The ordered list of subtasks for this deployment operation. This
attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of the current appliance status. This attribute
was added in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">CommonInfo#status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>notifications</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>) – Notifications containing upgrade info, errors and warnings. This
attribute was added in vSphere API 8.0.3.0.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an infos, errors or warnings have been
reported by the upgrade process.</p></li>
<li><p><strong>upgrade_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.UpgradeInfo" title="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.UpgradeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.UpgradeInfo</span></code></a>) – The metadata of the upgrade process. This attribute was added in
vSphere API 8.0.3.0.</p></li>
<li><p><strong>last_update_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The time when the status has been updated. This attribute was added
in vSphere API 8.0.3.0.</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 operation associated with the task.</p></li>
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
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.vapi.service</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.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
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.vapi.operation</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.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
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.cis.task</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.cis.task</span></code>.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
If None the description of why the operation failed will be
included in the result of the operation (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">State</span></span><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.deployment.migration_upgrade_client.Status.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Status.State</span></code> class defines the various states of the migration
upgrade process. This enumeration was added in vSphere API 8.0.3.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></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">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.CANCELED">
<span class="sig-name descname"><span class="pre">CANCELED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.CANCELED" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade has been canceled. This class attribute was added in vSphere
API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.CANCELING">
<span class="sig-name descname"><span class="pre">CANCELING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='CANCELING')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.CANCELING" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is canceling. In this state the source appliance will
reverted to the state as it was before the start of the upgrade process.
This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.INITIALIZED">
<span class="sig-name descname"><span class="pre">INITIALIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='INITIALIZED')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.INITIALIZED" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is successfully initialized with the defined migration
configuration. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.INITIALIZING">
<span class="sig-name descname"><span class="pre">INITIALIZING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='INITIALIZING')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.INITIALIZING" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is initializing with the defined migration
configuration. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.PREPARED">
<span class="sig-name descname"><span class="pre">PREPARED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='PREPARED')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.PREPARED" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process have prepared the source in ready state for switchover
i.e it has replicated most of the data and there will be only some small
delta of the data for replication during switchover. This class attribute
was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.PREPARING">
<span class="sig-name descname"><span class="pre">PREPARING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='PREPARING')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.PREPARING" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is replicating the source data to the newly deployed
target appliance. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.STAGED">
<span class="sig-name descname"><span class="pre">STAGED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='STAGED')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.STAGED" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process deployed the new version and is ready for the next step
of the process. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.STAGING">
<span class="sig-name descname"><span class="pre">STAGING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='STAGING')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.STAGING" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is downloading or deploying the new target appliance
version. This class attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.SWITCHOVER">
<span class="sig-name descname"><span class="pre">SWITCHOVER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='SWITCHOVER')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.SWITCHOVER" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process is promoting the target appliance as an active one.
This includes powering off the current active appliance, migrating the
network identity, and activating the current standby appliance. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.UPGRADED">
<span class="sig-name descname"><span class="pre">UPGRADED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='UPGRADED')</span></em><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State.UPGRADED" title="Permalink to this definition"></a></dt>
<dd><p>The upgrade process promoted the target appliance successfully. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Task">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">progress</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">notifications</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">service</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">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</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</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">status</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">cancelable</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">error</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">start_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">end_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">user</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.deployment.migration_upgrade_client.Status.Task" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Status.Task</span></code> class contains attributes to describe a particular
deployment task. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this deployment task. This attribute was added
in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">CommonInfo#status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>notifications</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>) – Result of the task. This attribute was added in vSphere API
8.0.3.0.
This attribute will be None if result is not available at the
current step of the task.</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 operation associated with the task.</p></li>
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
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.vapi.service</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.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
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.vapi.operation</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.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
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.cis.task</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.cis.task</span></code>.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
If None the description of why the operation failed will be
included in the result of the operation (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.UpgradeInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpgradeInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upgrade_state</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">desired_state</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">scheduled_downtime</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">remaining_replication_data</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.deployment.migration_upgrade_client.Status.UpgradeInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Status.UpgradeInfo</span></code> class contains attributes to describe important
parameters and state of the upgrade process. This class was added in
vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>upgrade_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State" title="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.State</span></code></a>) – The current state of migration upgrade process. This attribute was
added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>desired_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State" title="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.State</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Desired state of the migration upgrade process. This attribute was
added in vSphere API 8.0.3.0.
If None there is no upgrade in the environment.</p></li>
<li><p><strong>scheduled_downtime</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The time when the switchover i.e the downtime will happen. This
attribute was added in vSphere API 8.0.3.0.
If None will mean that the upgrade action called will be executed
right after the prepare step.</p></li>
<li><p><strong>remaining_replication_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The size of the data (in MB) that is left to be replicated from the
source machine to the target machine. This attribute was added in
vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the current status of the appliance migration upgrade. This
method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Info" title="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Info structure containing the status information about the
appliance.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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 caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></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>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcLifecycle.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.lcm.deployment.migration_upgrade_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm.deployment.migration_upgrade_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.deployment.migration_upgrade_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.lcm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.lcm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<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>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink