<spanid="com-vmware-vcenter-package"></span><h1>com.vmware.vcenter package<aclass="headerlink"href="#module-com.vmware.vcenter"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-certificate-management-client-module"></span><h2>com.vmware.vcenter.certificate_management_client module<aclass="headerlink"href="#module-com.vmware.vcenter.certificate_management_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.certificate_management_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.certificate_management_client.</code><codeclass="descname">X509CertChain</code><spanclass="sig-paren">(</span><em>cert_chain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management_client.X509CertChain"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cert_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Certificate chain in base64 format. This attribute was added in
<spanid="com-vmware-vcenter-compute-client-module"></span><h2>com.vmware.vcenter.compute_client module<aclass="headerlink"href="#module-com.vmware.vcenter.compute_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client</span></code> module provides classes for managing
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute_client.</code><codeclass="descname">Policies</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.compute.Policy'</em><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the compute policy. <strong>Warning:</strong> This class attribute is
available as technical preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>policy=None</em>, <em>name=None</em>, <em>description=None</em>, <em>capability=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy. <strong>Warning:</strong> This attribute is available
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as technical preview. It may be changed in a future release.</p></li>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new compute policy. <strong>Warning:</strong> This method is available as
technical preview. It may be changed in a future release.</p>
<ddclass="field-odd"><p><strong>spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code>) – Specification for the new policy to be created. The new policy will
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a specific compute policy. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<ddclass="field-odd"><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy to be deleted.
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a specific compute policy. <strong>Warning:</strong> This
method is available as technical preview. It may be changed in a future
<ddclass="field-odd"><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy for which information should be retrieved.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the compute policies available in this
vCenter server. <strong>Warning:</strong> This method is available as technical
preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.compute_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-datastore-client-module"></span><h2>com.vmware.vcenter.datastore_client module<aclass="headerlink"href="#module-com.vmware.vcenter.datastore_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.datastore_client.</code><codeclass="descname">DefaultPolicy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.datastore_client.DefaultPolicy"title="Permalink to this definition">¶</a></dt>
specific datastore. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>datastore</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifier of the current default storage policy associated
with the specified datastore. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore for which the default policy is
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.datastore_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.datastore_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-deployment-client-module"></span><h2>com.vmware.vcenter.deployment_client module<aclass="headerlink"href="#module-com.vmware.vcenter.deployment_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">ApplianceState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CONFIGURED</code><emclass="property"> = ApplianceState(string='CONFIGURED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIGURED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance has been configured. This class attribute was added in
<codeclass="descname">CONFIG_IN_PROGRESS</code><emclass="property"> = ApplianceState(string='CONFIG_IN_PROGRESS')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIG_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is in the process of being configured. This class attribute
<codeclass="descname">FAILED</code><emclass="property"> = ApplianceState(string='FAILED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance configuration has failed. This class attribute was added in
<codeclass="descname">INITIALIZED</code><emclass="property"> = ApplianceState(string='INITIALIZED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.INITIALIZED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is initialized and ready to be configured. This class
<codeclass="descname">NOT_INITIALIZED</code><emclass="property"> = ApplianceState(string='NOT_INITIALIZED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.NOT_INITIALIZED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is in the process of being initialized and not ready for
<codeclass="descname">QUESTION_RAISED</code><emclass="property"> = ApplianceState(string='QUESTION_RAISED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.QUESTION_RAISED"title="Permalink to this definition">¶</a></dt>
<dd><p>The deployment script has raised a question and is waiting for an answer to
continue with the appliance configuration. This class attribute was added
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">ApplianceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">PSC_EXTERNAL</code><emclass="property"> = ApplianceType(string='PSC_EXTERNAL')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.PSC_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
<codeclass="descname">VCSA_EMBEDDED</code><emclass="property"> = ApplianceType(string='VCSA_EMBEDDED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EMBEDDED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
<codeclass="descname">VCSA_EXTERNAL</code><emclass="property"> = ApplianceType(string='VCSA_EXTERNAL')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">CheckInfo</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>result=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.CheckStatus"title="com.vmware.vcenter.deployment_client.CheckStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CheckStatus</span></code></a>) – Status of the check. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notifications"title="com.vmware.vcenter.deployment_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the check. This attribute was added in vSphere API 6.7.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">CheckStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckStatus"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">FAILED</code><emclass="property"> = CheckStatus(string='FAILED')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckStatus.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>A fatal error was encountered when running the sanity checks. This class
<codeclass="descname">SUCCESS</code><emclass="property"> = CheckStatus(string='SUCCESS')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckStatus.SUCCESS"title="Permalink to this definition">¶</a></dt>
<dd><p>All checks have completed successfully. This class attribute was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">HistoryMigrationOption</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ALL</code><emclass="property"> = HistoryMigrationOption(string='ALL')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.ALL"title="Permalink to this definition">¶</a></dt>
<dd><p>All history data will be migrated along with the core data. This class
<codeclass="descname">EVENTS_TASKS</code><emclass="property"> = HistoryMigrationOption(string='EVENTS_TASKS')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.EVENTS_TASKS"title="Permalink to this definition">¶</a></dt>
<dd><p>Only event data and task data will be migrated along with the core data.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">HistoryMigrationSpec</code><spanclass="sig-paren">(</span><em>data_set=None</em>, <em>defer_import=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>data_set</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption"title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationOption</span></code></a>) – Defines what part of vCenter historical data will be migrated along
with core data. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>defer_import</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Defines how vCenter history will be migrated. If set to true,
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">ImportHistory</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the vCenter history import task. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the vCenter history import task. This attribute was
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this task. This attribute was added in vSphere
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notifications"title="com.vmware.vcenter.deployment_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the operation. If an operation reports partial results
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. The value
could change as the operation progresses. This attribute was added
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the task for importing vCenter historical data. This method was
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current status of the vCenter historical data import. This
<codeclass="descname">pause</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.pause"title="Permalink to this definition">¶</a></dt>
<dd><p>Pauses the task for importing vCenter historical data. This method was
<codeclass="descname">resume</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.resume"title="Permalink to this definition">¶</a></dt>
<dd><p>Resumes the task for importing vCenter historical data. This method was
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>spec=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates and starts task for importing vCenter historical data. This
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"title="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ImportHistory.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>An optional <codeclass="docutils literal notranslate"><spanclass="pre">ImportHistory.CreateSpec</span></code> info that can be passed
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Install</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install"title="Permalink to this definition">¶</a></dt>
appliance. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">InstallSpec</code><spanclass="sig-paren">(</span><em>vcsa_embedded=None</em>, <em>auto_answer=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.InstallSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"title="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.VcsaEmbeddedSpec</span></code></a>) – Spec used to configure an embedded vCenter Server. This field
configured. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>auto_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Use the default option for any questions that may come up during
<emclass="property">class </em><codeclass="descname">VcsaEmbeddedSpec</code><spanclass="sig-paren">(</span><em>standalone=None</em>, <em>replicated=None</em>, <em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.StandaloneSpec"title="com.vmware.vcenter.deployment_client.StandaloneSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StandaloneSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone embedded vCenter Server. This
be configured. This attribute was added in vSphere API 6.7.
If None, will default to None.</p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ReplicatedSpec"title="com.vmware.vcenter.deployment_client.ReplicatedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicatedSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated embedded vCenter Server. This
be configured. This attribute was added in vSphere API 6.7.
If None, will default to None.</p></li>
<li><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether CEIP should be enabled or disabled. This attribute was
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the appliance installation that is in progress. This method was
<codeclass="descname">check</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Run sanity checks using the InstallSpec parameters passed. This method
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the parameters used to configure the ongoing appliance
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">LocationSpec</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>https_port=None</em>, <em>ssl_thumbprint=None</em>, <em>ssl_verify=None</em>, <em>username=None</em>, <em>password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.LocationSpec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the container. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the container. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is
value is set to false. This attribute was added in vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator account on the host. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator account password. This attribute was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Notification</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>time=None</em>, <em>message=None</em>, <em>resolution=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Notification"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The notification id. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time the notification was raised/found. This attribute was
added in vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if the time information is available.</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>resolution</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The resolution message, if any. This attribute was added in vSphere
API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> for warnings and errors.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Notifications</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>warnings=None</em>, <em>errors=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Notifications"title="Permalink to this definition">¶</a></dt>
<li><p><strong>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Info notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an info was reported by the task.</p></li>
<li><p><strong>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Warning notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an warning was reported by the task.</p></li>
<li><p><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an error was reported by the task.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Operation</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">INSTALL</code><emclass="property"> = Operation(string='INSTALL')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.INSTALL"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance installation is in progress. This class attribute was added
<codeclass="descname">MIGRATE</code><emclass="property"> = Operation(string='MIGRATE')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.MIGRATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance migration is in progress. This class attribute was added in
<codeclass="descname">RESTORE</code><emclass="property"> = Operation(string='RESTORE')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.RESTORE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance restoration is in progress. This class attribute was added in
<codeclass="descname">ROLLBACK</code><emclass="property"> = Operation(string='ROLLBACK')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.ROLLBACK"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is being rolled back to an unconfigured state. This class
<codeclass="descname">UPGRADE</code><emclass="property"> = Operation(string='UPGRADE')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.UPGRADE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance upgrade is in progress. This class attribute was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Question</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question"title="Permalink to this definition">¶</a></dt>
deployment and to answer them. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">AnswerSpec</code><spanclass="sig-paren">(</span><em>question_id=None</em>, <em>answer_val=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>question_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Id of the question being answered. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>answer_val</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The answer value. This attribute was added in vSphere API 6.7.</p></li>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>questions=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.Info"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>questions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.Question"title="com.vmware.vcenter.deployment_client.Question.Question"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.Question</span></code></a>) – One or more questions raised during the deployment. This attribute
<emclass="property">class </em><codeclass="descname">Question</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>question=None</em>, <em>type=None</em>, <em>default_answer=None</em>, <em>possible_answers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.Question"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Id of the question raised. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>question</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message describing the question. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.QuestionType"title="com.vmware.vcenter.deployment_client.Question.QuestionType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.QuestionType</span></code></a>) – Type of the question raised. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>default_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Default answer value. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>possible_answers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Possible answers values. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">QuestionType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ABORT_RETRY_IGNORE</code><emclass="property"> = QuestionType(string='ABORT_RETRY_IGNORE')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.ABORT_RETRY_IGNORE"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Abort/Retry/Ignore. This class attribute was
<codeclass="descname">OK_CANCEL</code><emclass="property"> = QuestionType(string='OK_CANCEL')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.OK_CANCEL"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Ok/Cancel. This class attribute was added in
<codeclass="descname">YES_NO</code><emclass="property"> = QuestionType(string='YES_NO')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.YES_NO"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Yes/No. This class attribute was added in
<codeclass="descname">answer</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.answer"title="Permalink to this definition">¶</a></dt>
<dd><p>Supply answer to the raised question. This method was added in vSphere
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec"title="com.vmware.vcenter.deployment_client.Question.AnswerSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.AnswerSpec</span></code></a>) – AnswerSpec with the answer to the raised question.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the question that was raised during the configuration. This method
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">RemotePscSpec</code><spanclass="sig-paren">(</span><em>psc_hostname=None</em>, <em>https_port=None</em>, <em>sso_admin_password=None</em>, <em>ssl_thumbprint=None</em>, <em>ssl_verify=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.RemotePscSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>psc_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC to which
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">ReplicatedPscSpec</code><spanclass="sig-paren">(</span><em>sso_site_name=None</em>, <em>partner_hostname=None</em>, <em>https_port=None</em>, <em>sso_admin_password=None</em>, <em>ssl_thumbprint=None</em>, <em>ssl_verify=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ReplicatedPscSpec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO sitename that will be used in PSC replication. This
attribute was added in vSphere API 6.7.
If None, default-first-site will be used.</p></li>
<li><p><strong>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">ReplicatedSpec</code><spanclass="sig-paren">(</span><em>partner_hostname=None</em>, <em>https_port=None</em>, <em>sso_admin_password=None</em>, <em>ssl_thumbprint=None</em>, <em>ssl_verify=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ReplicatedSpec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">StandalonePscSpec</code><spanclass="sig-paren">(</span><em>sso_site_name=None</em>, <em>sso_admin_password=None</em>, <em>sso_domain_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.StandalonePscSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO site name used for this PSC. This attribute was added in
vSphere API 6.7.
If None, default-first-site will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">StandaloneSpec</code><spanclass="sig-paren">(</span><em>sso_admin_password=None</em>, <em>sso_domain_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.StandaloneSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">Upgrade</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">PscSpec</code><spanclass="sig-paren">(</span><em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the source appliance. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled for the source
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the root user on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>ssh_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Appliance SSH verification should be enabled or disabled. By
<li><p><strong>ssh_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MD5 thumbprint of the server SSH key will be used for verification.
<emclass="property">class </em><codeclass="descname">UpgradeSpec</code><spanclass="sig-paren">(</span><em>source_appliance=None</em>, <em>source_location=None</em>, <em>history=None</em>, <em>vcsa_embedded=None</em>, <em>psc=None</em>, <em>auto_answer=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>source_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"title="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.SourceApplianceSpec</span></code></a>) – Source appliance spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.LocationSpec"title="com.vmware.vcenter.deployment_client.LocationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocationSpec</span></code></a>) – Source location spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>history</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec"title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Determines how vCenter history will be migrated during the upgrade
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"title="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.VcsaEmbeddedSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information that are specific to this embedded vCenter Server. This
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec"title="com.vmware.vcenter.deployment_client.Upgrade.PscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.PscSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information that are specific to this Platform Services Controller.
This attribute was added in vSphere API 6.7.
If None, ceip_enabled for psc upgrade will default to enabled.</p></li>
<li><p><strong>auto_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Use the default option for any questions that may come up during
<emclass="property">class </em><codeclass="descname">VcsaEmbeddedSpec</code><spanclass="sig-paren">(</span><em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the appliance upgrade that is in progress. This method was added
<codeclass="descname">check</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Run sanity checks using the UpgradeSpec parameters passed. This method
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the UpgradeSpec parameters used to configure the ongoing appliance
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.deployment_client.</code><codeclass="descname">VerificationMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.VerificationMode"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">NONE</code><emclass="property"> = VerificationMode(string='NONE')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.VerificationMode.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No verification will be performed. This class attribute was added in
<codeclass="descname">THUMBPRINT</code><emclass="property"> = VerificationMode(string='THUMBPRINT')</em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.VerificationMode.THUMBPRINT"title="Permalink to this definition">¶</a></dt>
<dd><p>Passed thumbprint will be used for verification. This class attribute was
<spanid="com-vmware-vcenter-guest-client-module"></span><h2>com.vmware.vcenter.guest_client module<aclass="headerlink"href="#module-com.vmware.vcenter.guest_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.guest_client</span></code> module provides classes for managing
guest customization specifications in the vCenter Server.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.guest_client.</code><codeclass="descname">CustomizationSpecs</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>names=None</em>, <em>os_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that guest customization specifications must have to match
<emclass="property">class </em><codeclass="descname">OsType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LINUX</code><emclass="property"> = OsType(string='LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.LINUX"title="Permalink to this definition">¶</a></dt>
<dd><p>A customization specification for a Linux guest operating system. This
<codeclass="descname">WINDOWS</code><emclass="property"> = OsType(string='WINDOWS')</em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.WINDOWS"title="Permalink to this definition">¶</a></dt>
<dd><p>A customization specification for a Windows guest operating system. This
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.guest.CustomizationSpec'</em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for a vCenter guest customization specification. This class
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>os_type=None</em>, <em>last_modified=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the guest customization specification. This attribute was
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the guest customization specification. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>os_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.OsType</span></code></a>) – Guest operating system type for which that this guest customization
<li><p><strong>last_modified</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Date and tme when this guest customization specification was last
modified. This attribute was added in vSphere API 6.7.1.</p></li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) guest customization specifications in vCenter matching the
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.FilterSpec</span></code></a>. This method was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.guest_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-hvc-client-module"></span><h2>com.vmware.vcenter.hvc_client module<aclass="headerlink"href="#module-com.vmware.vcenter.hvc_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc_client</span></code> module provides classes to manage hybrid
links between a local and remote Platform Service Controller.</p>
<dlclass="class">
<dtid="com.vmware.vcenter.hvc_client.Links">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc_client.</code><codeclass="descname">Links</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">CertificateInfo</code><spanclass="sig-paren">(</span><em>ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.CertificateInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SHA-256 thumbprint of the SSL certificate for the destination
<li><p><strong>psc_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The PSC hostname for the domain to be linked. <strong>Warning:</strong> This
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the PSC to be linked. <strong>Warning:</strong> This attribute
<li><p><strong>domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain to which the PSC belongs. <strong>Warning:</strong> This attribute is
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator username of the PSC. <strong>Warning:</strong> This attribute
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator password of the PSC. <strong>Warning:</strong> This attribute
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ssl thumbprint of the server. <strong>Warning:</strong> This attribute is
<li><p><strong>admin_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of groups to be added to enable administrator access to.
<emclass="property">class </em><codeclass="descname">Credentials</code><spanclass="sig-paren">(</span><em>user_name=None</em>, <em>password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.Credentials"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links.Credentials</span></code> class specifies user credentials to make a
successful connection to remote endpoint. <strong>Warning:</strong> This class is
available as technical preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</p></li>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>link=None</em>, <em>display_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier for the link. <strong>Warning:</strong> This attribute is
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name is set to the domain name which was set during
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new hybrid link between the local and foreign PSC.
<strong>Warning:</strong> This method is available as technical preview. It may be
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc_client.Links.CreateSpec"title="com.vmware.vcenter.hvc_client.Links.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Links.CreateSpec</span></code></a>) – Specification for the new link to be created.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>link</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an existing hybrid link. <strong>Warning:</strong> This method is available
as technical preview. It may be changed in a future release.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Enumerates the list of registered hybrid links. <strong>Warning:</strong> This
method is available as technical preview. It may be changed in a future
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-identity-client-module"></span><h2>com.vmware.vcenter.identity_client module<aclass="headerlink"href="#module-com.vmware.vcenter.identity_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.identity_client</span></code> module provides classes to manage
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.identity_client.</code><codeclass="descname">Providers</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers</span></code> interface provides methods to list, read and modify
vCenter Server identity providers. <strong>Warning:</strong> This class is available as
technical preview. It may be changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">ConfigType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code> class contains the possible types of vCenter
Server identity providers. <strong>Warning:</strong> This enumeration is available as
technical preview. It may be changed in a future release.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">Oauth2</code><emclass="property"> = ConfigType(string='Oauth2')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="Permalink to this definition">¶</a></dt>
<dd><p>Config for OAuth2. <strong>Warning:</strong> This class attribute is available as
technical preview. It may be changed in a future release.</p>
<codeclass="descname">Oidc</code><emclass="property"> = ConfigType(string='Oidc')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="Permalink to this definition">¶</a></dt>
<dd><p>Config for OIDC. <strong>Warning:</strong> This class attribute is available as
technical preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>config_tag=None</em>, <em>oauth2=None</em>, <em>oidc=None</em>, <em>org_ids=None</em>, <em>is_default=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"title="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2CreateSpec</span></code></a>) – OAuth2 CreateSpec. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"title="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcCreateSpec</span></code></a>) – OIDC CreateSpec. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The set of orgIds as part of SDDC creation which provides the basis
for tenancy. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
If None, the set will be empty.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether the provider is the default provider. Setting
<codeclass="docutils literal notranslate"><spanclass="pre">isDefault</span></code> of current provider to True makes all other providers
non-default. If no other providers created in this vCenter Server
before, this parameter will be disregarded, and the provider will
always be set to the default. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
If None the provider will be the default provider if it is the
first provider that is created, and will not be the default
provider otherwise.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Friendly name for the provider. This must be unique, otherwise
calling <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> will throw
<emclass="property">class </em><codeclass="descname">IdentityManagementEndpoint</code><spanclass="sig-paren">(</span><em>usage_hint=None</em>, <em>endpoint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.IdentityManagementEndpoint</span></code> class is an provider endpoint
that the client can manage users and groups with. <strong>Warning:</strong> This class
is available as technical preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>usage_hint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This is a client specified hint on how to use this endpoint.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
If None, the hint will be empty.</p></li>
<li><p><strong>endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identity management endpoint URL. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>org_ids=None</em>, <em>config_tag=None</em>, <em>oauth2=None</em>, <em>oidc=None</em>, <em>is_default=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Info</span></code> class contains the information about an identity
provider. <strong>Warning:</strong> This class is available as technical preview. It may
be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The set of orgIds as part of SDDC creation which provides the basis
for tenancy. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.</p></li>
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info"title="com.vmware.vcenter.identity_client.Providers.Oauth2Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2Info</span></code></a>) – OAuth2 Info. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcInfo"title="com.vmware.vcenter.identity_client.Providers.OidcInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcInfo</span></code></a>) – OIDC Info. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Specifies whether the provider is the default provider.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">Oauth2AuthenticationMethod</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code> class contains the possible
types of OAuth2 authentication methods. <strong>Warning:</strong> This enumeration is
available as technical preview. It may be changed in a future release.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Oauth2AuthenticationMethod</span></code> instance.</p>
<codeclass="descname">CLIENT_SECRET_BASIC</code><emclass="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_BASIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, authenticate with the Authorization Server in accordance with
Section 3.2.1 of OAuth 2.0 [RFC6749] using the HTTP Basic authentication
scheme. <strong>Warning:</strong> This class attribute is available as technical
preview. It may be changed in a future release.</p>
<codeclass="descname">CLIENT_SECRET_JWT</code><emclass="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_JWT"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, create a JWT using an HMAC SHA algorithm, such as HMAC SHA-256. The
HMAC (Hash-based Message Authentication Code) is calculated using the
octets of the UTF-8 representation of the client_secret as the shared key.
<strong>Warning:</strong> This class attribute is available as technical preview. It may
<codeclass="descname">CLIENT_SECRET_POST</code><emclass="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_POST"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, authenticate with the Authorization Server in accordance with
Section 3.2.1 of OAuth 2.0 [RFC6749] by including the Client Credentials in
the request body. <strong>Warning:</strong> This class attribute is available as
technical preview. It may be changed in a future release.</p>
<codeclass="descname">PRIVATE_KEY_JWT</code><emclass="property"> = Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')</em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.PRIVATE_KEY_JWT"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have registered a public key sign a JWT using that key. The
client authenticates in accordance with JSON Web Token (JWT) Profile for
OAuth 2.0 Client Authentication and Authorization Grants [OAuth.JWT] and
Assertion Framework for OAuth 2.0 Client Authentication and Authorization
Grants [OAuth.Assertions]. <strong>Warning:</strong> This class attribute is available
as technical preview. It may be changed in a future release.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2CreateSpec</span></code> class contains the information used to
create an OAuth2 identity provider. <strong>Warning:</strong> This class is available as
technical preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>k/v pairs that are to be appended to the authEndpoint request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. <strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
If None, the map will be empty.</p>
</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"title="com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdentityManagementEndpoint</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identity management endpoints provided by the provider. The list
can be empty if the provider has no management capability.
<strong>Warning:</strong> This attribute is available as technical preview. It
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2Info</span></code> class contains the information about an OAuth2
identity provider. <strong>Warning:</strong> This class is available as technical
preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>k/v pairs that are to be appended to the authEndpoint request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
<p>. <strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p>
</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"title="com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdentityManagementEndpoint</span></code></a>) – Identity management endpoints provided by the provider. The list
can be empty if the provider has no management capability.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">Oauth2Summary</code><spanclass="sig-paren">(</span><em>auth_endpoint=None</em>, <em>token_endpoint=None</em>, <em>client_id=None</em>, <em>authentication_header=None</em>, <em>auth_query_params=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2Summary</span></code> class contains commonly used information
about an OAuth2 identity provider. <strong>Warning:</strong> This class is available as
technical preview. It may be changed in a future release.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>authentication_header</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The authentication data used as part of request header to acquire
or refresh an OAuth2 token. The data format depends on the
authentication method used. Example of basic authentication format:
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>k/v pairs that are to be appended to the authEndpoint request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. <strong>Warning:</strong> This attribute is available as technical preview. It
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
If None, leaves value unchanged.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint to retrieve the provider public key for validation.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Shared secret between identity provider and client. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
If None, leaves value unchanged.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Authentication method used by the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – k/v pairs that are to be appended to the authEndpoint request. How
to append to authEndpoint request: If the map is not empty, a “?”
is added to the endpoint URL, and combination of each k and each
string in the v is added with an “&” delimiter. Details: If the
value contains only one string, then the key is added with “k=v”.
If the value is an empty list, then the key is added without a
“=v”. If the value contains multiple strings, then the key is
repeated in the query-string for each string in the value. If the
map is empty, deletes all params. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
If None, leaves value unchanged.</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"title="com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdentityManagementEndpoint</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identity management endpoints provided by the provider. The list
can be empty if the provider has no management capability.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">OidcCreateSpec</code><spanclass="sig-paren">(</span><em>discovery_endpoint=None</em>, <em>client_id=None</em>, <em>client_secret=None</em>, <em>claim_map=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider metadata. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
<li><p><strong>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider metadata. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>k/v pairs that are to be appended to the authEndpoint request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. <strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p>
</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"title="com.vmware.vcenter.identity_client.Providers.IdentityManagementEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdentityManagementEndpoint</span></code></a>) – Identity management endpoints provided by the provider. The list
can be empty if the provider has no management capability.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">OidcSummary</code><spanclass="sig-paren">(</span><em>auth_endpoint=None</em>, <em>token_endpoint=None</em>, <em>client_id=None</em>, <em>authentication_header=None</em>, <em>auth_query_params=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.OidcSummary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>authentication_header</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The authentication data used as part of request header to acquire
or refresh an OAuth2 token. The data format depends on the
authentication method used. Example of basic authentication format:
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>k/v pairs that are to be appended to the authEndpoint request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. <strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">OidcUpdateSpec</code><spanclass="sig-paren">(</span><em>discovery_endpoint=None</em>, <em>client_id=None</em>, <em>client_secret=None</em>, <em>claim_map=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint to retrieve the provider metadata. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client identifier to connect to the provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The secret shared between the client and the provider. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>provider=None</em>, <em>config_tag=None</em>, <em>oauth2=None</em>, <em>oidc=None</em>, <em>is_default=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.identity.Providers</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary"title="com.vmware.vcenter.identity_client.Providers.Oauth2Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2Summary</span></code></a>) – OAuth2 Summary. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcSummary"title="com.vmware.vcenter.identity_client.Providers.OidcSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcSummary</span></code></a>) – OIDC Summary. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Specifies whether the provider is the default provider.
<strong>Warning:</strong> This attribute is available as technical preview. It
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>config_tag=None</em>, <em>oauth2=None</em>, <em>oidc=None</em>, <em>org_ids=None</em>, <em>is_default=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"title="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2UpdateSpec</span></code></a>) – OAuth2 UpdateSpec. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"title="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcUpdateSpec</span></code></a>) – OIDC UpdateSpec. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The set orgIds as part of SDDC creation which provides the basis
for tenancy. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether the provider is the default provider. Setting
<codeclass="docutils literal notranslate"><spanclass="pre">isDefault</span></code> of current provider to True makes all other providers
non-default. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
If None, leaves value unchanged.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Friendly name for this provider. This must be unique, otherwise
calling <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> will throw
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a vCenter Server identity provider. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.CreateSpec"title="com.vmware.vcenter.identity_client.Providers.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.CreateSpec</span></code></a>) – the CreateSpec contains the information used to create the provider</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>provider</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a vCenter Server identity provider. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider to delete
The parameter must be an identifier for the resource type:
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>provider</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve detailed information of the specified identity provider.
<strong>Warning:</strong> This method is available as technical preview. It may be
changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider
The parameter must be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve all identity providers. <strong>Warning:</strong> This method is available
as technical preview. It may be changed in a future release.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>provider</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update a vCenter Server identity provider. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider to update
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec"title="com.vmware.vcenter.identity_client.Providers.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec</span></code></a>) – the UpdateSpec contains the information used to update the provider</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.identity_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-inventory-client-module"></span><h2>com.vmware.vcenter.inventory_client module<aclass="headerlink"href="#module-com.vmware.vcenter.inventory_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.inventory_client</span></code> component provides methods and
classes for retrieving vCenter datastore and network information for a given
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of identifiers.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.inventory_client.</code><codeclass="descname">Datastore</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Datastore"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> class provides methods to retrieve information about
datastores.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Datastore.Info"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the datastore.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">StoragePod</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">StoragePod</span></code>.</p>
<codeclass="descname">find</code><spanclass="sig-paren">(</span><em>datastores</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Datastore.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns datastore information for the specified datastores. The key in
the return value <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the datastore identifier and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the datastore information.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the datastores for which information will be
returned.
The parameter must contain identifiers for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.inventory_client.</code><codeclass="descname">Network</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Network"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code> class provides methods to retrieve information about
vCenter Server networks.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Network.Info"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the vCenter Server network.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">DistributedVirtualPortgroup</span></code>, or <codeclass="docutils literal notranslate"><spanclass="pre">OpaqueNetwork</span></code>. When methods
return a value of this class as a return value, the attribute will
be one of <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">DistributedVirtualPortgroup</span></code>, or
<codeclass="descname">find</code><spanclass="sig-paren">(</span><em>networks</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Network.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns network information for the specified vCenter Server networks.
The key in the return value <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the network identifier and
the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the network information.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the vCenter Server networks for which information
will be returned.
The parameter must contain identifiers for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.inventory_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-iso-client-module"></span><h2>com.vmware.vcenter.iso_client module<aclass="headerlink"href="#module-com.vmware.vcenter.iso_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.iso_client</span></code> module provides classes and classes that
will let its client mount or unmount an ISO image on a virtual machine as a
CD-ROM.</p>
<dlclass="class">
<dtid="com.vmware.vcenter.iso_client.Image">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.iso_client.</code><codeclass="descname">Image</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.Image"title="Permalink to this definition">¶</a></dt>
<p>Provides an interface to mount and unmount an ISO image on a virtual
machine.</p>
<p>This is an API that will let its client mount or unmount an ISO image on a
virtual machine as a CD-ROM.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">mount</code><spanclass="sig-paren">(</span><em>library_item</em>, <em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.Image.mount"title="Permalink to this definition">¶</a></dt>
<dd><p>Mounts an ISO image from a content library on a virtual machine.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>library_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the library item having the ISO image to mount on
the virtual machine.
The parameter must be an identifier for the resource type:
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine where the specified ISO image
will be mounted.
The parameter must be an identifier for the resource type:
If either <codeclass="docutils literal notranslate"><spanclass="pre">vm</span></code> or the <codeclass="docutils literal notranslate"><spanclass="pre">library_item</span></code> is not found.</p>
<codeclass="descname">unmount</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.Image.unmount"title="Permalink to this definition">¶</a></dt>
<dd><p>Unmounts a previously mounted CD-ROM using an ISO image as a backing.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine from which to unmount the
virtual CD-ROM.
The parameter must be an identifier for the resource type:
<li><p><strong>cdrom</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type:
by the parameter <codeclass="docutils literal notranslate"><spanclass="pre">cdrom</span></code> requires <codeclass="docutils literal notranslate"><spanclass="pre">System.Read</span></code>.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.iso_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-lcm-client-module"></span><h2>com.vmware.vcenter.lcm_client module<aclass="headerlink"href="#module-com.vmware.vcenter.lcm_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">ApplianceSize</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LARGE</code><emclass="property"> = ApplianceSize(string='LARGE')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize.LARGE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MEDIUM</code><emclass="property"> = ApplianceSize(string='MEDIUM')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize.MEDIUM"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SMALL</code><emclass="property"> = ApplianceSize(string='SMALL')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize.SMALL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TINY</code><emclass="property"> = ApplianceSize(string='TINY')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize.TINY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">XLARGE</code><emclass="property"> = ApplianceSize(string='XLARGE')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceSize.XLARGE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">ApplianceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">PSC</code><emclass="property"> = ApplianceType(string='PSC')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceType.PSC"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VCSA_EMBEDDED</code><emclass="property"> = ApplianceType(string='VCSA_EMBEDDED')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VCSA_EXTERNAL</code><emclass="property"> = ApplianceType(string='VCSA_EXTERNAL')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMC</code><emclass="property"> = ApplianceType(string='VMC')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ApplianceType.VMC"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">CeipOnlySso</code><spanclass="sig-paren">(</span><em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.CeipOnlySso"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This key describes the enabling option for the VMware’s Customer
Experience Improvement Program (CEIP). By default we have
<codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: true, which indicates that you are joining CEIP.
If you prefer not to participate in the VMware’s CEIP for this
product, you must disable CEIP by setting <codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: false.
You may join or leave VMware’s CEIP for this product at any time.
If None, defaults to True</p>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Connection">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Connection</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>username=None</em>, <em>password=None</em>, <em>https_port=None</em>, <em>ssl_verify=None</em>, <em>ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Connection"title="Permalink to this definition">¶</a></dt>
<p>Connection information for source/destination location.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the ESX/VC host. If a DNS
resolvable name is provided, it must be resolvable from the machine
that is running the installer.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A username with administrative privileges on the ESX/VC host.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the ‘username’ on the ESX/VC host.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The port number for the ESX/VC.
If None, defaults to 443</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to True</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Thumbprint for SSL verification.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> if false, this field is not required</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">DeploymentInfo</code><spanclass="sig-paren">(</span><em>appliance_name=None</em>, <em>appliance_fqdn=None</em>, <em>appliance_ips=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.DeploymentInfo"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance.</p></li>
<li><p><strong>appliance_fqdn</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The FQDN of the appliance.
Not applicable before firstboot.</p></li>
<li><p><strong>appliance_ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ip addresses of the appliance.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">DeploymentOption</code><spanclass="sig-paren">(</span><em>skip_options=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.DeploymentOption"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>skip_options</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DeploymentOption.SkipOptions"title="com.vmware.vcenter.lcm_client.DeploymentOption.SkipOptions"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption.SkipOptions</span></code></a> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – The options control if a task should be skipped.</p>
<emclass="property">class </em><codeclass="descname">SkipOptions</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.DeploymentOption.SkipOptions"title="Permalink to this definition">¶</a></dt>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SkipOptions</span></code> instance.</p>
<codeclass="descname">SKIP_SSO_CHECK</code><emclass="property"> = SkipOptions(string='SKIP_SSO_CHECK')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.DeploymentOption.SkipOptions.SKIP_SSO_CHECK"title="Permalink to this definition">¶</a></dt>
<dd><p>Skips the sso check. This should only be used when performing precheck for
install/upgrade of management node before infrastructure node is deployed.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">DestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.DestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Esx"title="com.vmware.vcenter.lcm_client.Esx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Esx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Vc"title="com.vmware.vcenter.lcm_client.Vc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Vc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">EmbeddedReplicatedVcsa</code><spanclass="sig-paren">(</span><em>sso_admin_password=None</em>, <em>sso_domain_name=None</em>, <em>partner_hostname=None</em>, <em>ssl_verify=None</em>, <em>ssl_thumbprint=None</em>, <em>https_port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the replicated Single Sign-On for Embedded type
deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator password of the existing Single Sign-On to be
replicated.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name for the remote appliance which is being replicated. For
example, ‘vsphere.local’</p></li>
<li><p><strong>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name for the remote appliance.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to True</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate which will be used
for verification.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is set to False, this field can be omitted</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">EmbeddedStandaloneVcsa</code><spanclass="sig-paren">(</span><em>sso_admin_password=None</em>, <em>sso_domain_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the standalone Single Sign-On for Embedded type
deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Single Sign-On domain name to be used to configure this vCenter
Server Appliance. For example, ‘vsphere.local’</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Esx">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Esx</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Esx"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.EsxInventory"title="com.vmware.vcenter.lcm_client.EsxInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EsxInventory</span></code></a>) – The configuration of ESX inventory.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">EsxInventory</code><spanclass="sig-paren">(</span><em>datastore_name=None</em>, <em>network_name=None</em>, <em>resource_pool_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.EsxInventory"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must be accessible
from the ESX host and must have at least 25 GB of free space.
Otherwise, the new appliance might not power on.</p></li>
<li><p><strong>network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The network of the ESX host to which the new appliance should
connect. Omit this parameter if the ESX host has one network.
If None, defaults to VM Network</p></li>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The path to the resource pool on the ESX host in which the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">ExistingMigrationAssistant</code><spanclass="sig-paren">(</span><em>ssl_thumbprint=None</em>, <em>https_port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the migration assistant that is already running on the
source Windows VC.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSL thumbprint of Migration Assistant. The SSL thumbprint can
be retrieved from the Migration Assistant console and log file.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Migration Assistant port number shown in the Migration Assistant
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">ExternalTool</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>hostname=None</em>, <em>location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ExternalTool"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the external tool</p></li>
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The host name of the external tool.
Can be absent when external tool does not have a host name.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the external tool.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">ExternalVcsa</code><spanclass="sig-paren">(</span><em>sso_admin_password=None</em>, <em>sso_domain_name=None</em>, <em>psc_hostname=None</em>, <em>ssl_verify=None</em>, <em>ssl_thumbprint=None</em>, <em>https_port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.ExternalVcsa"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the Single Sign-On for Management type deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator password of the external PSC to register with.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name of the external PSC. For example, ‘vsphere.local’</p></li>
<li><p><strong>psc_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC to which
this configuring vCenter Server will be registered.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the SSL verification is required
If <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to False</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate which will be used
for verification.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is set to False, this field can be omitted.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">GuestCredential</code><spanclass="sig-paren">(</span><em>os_username=None</em>, <em>os_password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.GuestCredential"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>os_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator username for the source Windows operating system.</p></li>
<li><p><strong>os_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator user password for the source Windows operating
system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.History">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">History</code><spanclass="sig-paren">(</span><em>defer_import=None</em>, <em>data_set=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.History"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the data to be exported during upgrade/migrate.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>defer_import</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the import of historical data should be
deferred until after upgrade/migrate.
If None, defaults to False</p></li>
<li><p><strong>data_set</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.History.DataSetType"title="com.vmware.vcenter.lcm_client.History.DataSetType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">History.DataSetType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of data to be upgraded/migrated.
<emclass="property">class </em><codeclass="descname">DataSetType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.History.DataSetType"title="Permalink to this definition">¶</a></dt>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataSetType</span></code> instance.</p>
<codeclass="descname">ALL</code><emclass="property"> = DataSetType(string='ALL')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.History.DataSetType.ALL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">EVENTS_TASKS</code><emclass="property"> = DataSetType(string='EVENTS_TASKS')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.History.DataSetType.EVENTS_TASKS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NONE</code><emclass="property"> = DataSetType(string='NONE')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.History.DataSetType.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>core only.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Install">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Install</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install"title="Permalink to this definition">¶</a></dt>
<p>The service to install Embedded VCSA, PSC, Management VCSA, VMC gateway.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>appliance_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType"title="com.vmware.vcenter.lcm_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a>) – The type of appliance to deploy.</p></li>
<li><p><strong>appliance_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="com.vmware.vcenter.lcm_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If None, defaults to SMALL</p></li>
<li><p><strong>appliance_disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If None, defaults to REGULAR</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>thin_disk_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVA file.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<li><p><strong>ovftool_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVF Tool.</p></li>
<li><p><strong>ovftool_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not to verify the SSL thumbprint of OVF
Tool location.
if None, Default to be True.</p></li>
<li><p><strong>ovftool_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of OVF Tool location to be verified.
When ovftoolLocationSslVerify is set to False, this field can be
omitted.</p></li>
<li><p><strong>services</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.DestinationApplianceService"title="com.vmware.vcenter.lcm_client.Install.DestinationApplianceService"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.DestinationApplianceService</span></code></a>) – The configuration of vCenter services.</p></li>
<li><p><strong>network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Network"title="com.vmware.vcenter.lcm_client.Network"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network</span></code></a>) – The network settings of the appliance to be deployed.</p></li>
<li><p><strong>time</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Time"title="com.vmware.vcenter.lcm_client.Time"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Time</span></code></a>) – Configuration of the vCSA time synchronization.</p></li>
<li><p><strong>ovftool_arguments</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The OVF Tool arguments to be included.
Not required when no OVF Tool argument to pass through</p></li>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.VcsaEmbedded"title="com.vmware.vcenter.lcm_client.Install.VcsaEmbedded"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.VcsaEmbedded</span></code></a>) – Spec used to configure an embedded vCenter Server. This field
describes how the embedded vCenter Server appliance should be
configured.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.VCSA_EMBEDDED</span></code></a>.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.Psc"title="com.vmware.vcenter.lcm_client.Install.Psc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.Psc</span></code></a>) – Spec used to configure a Platform Services Controller. This section
describes how the Platform Services Controller appliance should be
configured. If unset, either <codeclass="docutils literal notranslate"><spanclass="pre">vcsaEmbedded</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">vcsaExternal</span></code>
must be provided.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.PSC"title="com.vmware.vcenter.lcm_client.ApplianceType.PSC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.PSC</span></code></a>.</p></li>
<li><p><strong>vcsa_external</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExternalVcsa"title="com.vmware.vcenter.lcm_client.ExternalVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalVcsa</span></code></a>) – Spec used to configure a vCenter Server registered with an external
PSC. If unset, either vcsa_embedded or psc must be provided.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EXTERNAL"title="com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EXTERNAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.VCSA_EXTERNAL</span></code></a>.</p></li>
<li><p><strong>vmc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExternalVcsa"title="com.vmware.vcenter.lcm_client.ExternalVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalVcsa</span></code></a>) – Spec used to configure a vCenter Server registered with an external
PSC. If unset, either vcsa_embedded or psc must be provided.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.VMC"title="com.vmware.vcenter.lcm_client.ApplianceType.VMC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.VMC</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descname">DestinationApplianceService</code><spanclass="sig-paren">(</span><em>rhttpproxy=None</em>, <em>ssh=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.DestinationApplianceService"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>rhttpproxy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.ReverseProxy"title="com.vmware.vcenter.lcm_client.Install.ReverseProxy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.ReverseProxy</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Port numbers on which the vCenter Server Appliance communicates
with the other vSphere components.
Default value used reverse proxy not provided</p></li>
<li><p><strong>ssh</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Ssh"title="com.vmware.vcenter.lcm_client.Ssh"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ssh</span></code></a>) – Whether to enable SSH on the vCenter Appliance.</p></li>
<emclass="property">class </em><codeclass="descname">Psc</code><spanclass="sig-paren">(</span><em>standalone=None</em>, <em>replicated=None</em>, <em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.Psc"title="Permalink to this definition">¶</a></dt>
<p>Spec used to configure a Platform Services Controller. This section
describes how the Platform Services Controller appliance should be
configured. If unset, either <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaEmbedded</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaExternal</span></code> must be
provided.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.PscStandalone"title="com.vmware.vcenter.lcm_client.PscStandalone"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PscStandalone</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone Platform Services Controller.
This section describes how the standalone PSC should be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.PscReplicated"title="com.vmware.vcenter.lcm_client.PscReplicated"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PscReplicated</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated Platform Services Controller.
This section describes how the replicated PSC should be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – This key describes the enabling option for the VMware’s Customer
Experience Improvement Program (CEIP). By default we have
<codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: true, which indicates that you are joining CEIP.
If you prefer not to participate in the VMware’s CEIP for this
product, you must disable CEIP by setting <codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: false.
You may join or leave VMware’s CEIP for this product at any time.</p></li>
<emclass="property">class </em><codeclass="descname">ReverseProxy</code><spanclass="sig-paren">(</span><em>http_port=None</em>, <em>https_port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.ReverseProxy"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">Spec</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.Spec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DestinationLocation"title="com.vmware.vcenter.lcm_client.DestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.DestinationAppliance"title="com.vmware.vcenter.lcm_client.Install.DestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.DestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<emclass="property">class </em><codeclass="descname">VcsaEmbedded</code><spanclass="sig-paren">(</span><em>standalone=None</em>, <em>replicated=None</em>, <em>ceip_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.VcsaEmbedded"title="Permalink to this definition">¶</a></dt>
<p>Spec used to configure an embedded vCenter Server. This field describes how
the embedded vCenter Server appliance should be configured.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa"title="com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EmbeddedStandaloneVcsa</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone embedded vCenter Server. This
field describes how the standalone vCenter Server appliance should
be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa"title="com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EmbeddedReplicatedVcsa</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated embedded vCenter Server. This
field describes how the replicated vCenter Server appliance should
be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – This key describes the enabling option for the VMware’s Customer
Experience Improvement Program (CEIP). By default we have
<codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: true, which indicates that you are joining CEIP.
If you prefer not to participate in the VMware’s CEIP for this
product, you must disable CEIP by setting <codeclass="docutils literal notranslate"><spanclass="pre">ceipEnabled</span></code>: false.
You may join or leave VMware’s CEIP for this product at any time.</p></li>
<codeclass="descname">check_task</code><spanclass="sig-paren">(</span><em>spec</em>, <em>options=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.check_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Performs a precheck for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.Spec"title="com.vmware.vcenter.lcm_client.Install.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.Spec</span></code></a>) – The specification of the deployment.</p></li>
<li><p><strong>options</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DeploymentOption"title="com.vmware.vcenter.lcm_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The deployment precheck options.</p></li>
<codeclass="descname">start_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Install.start_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys the appliance for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Install.Spec"title="com.vmware.vcenter.lcm_client.Install.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.Spec</span></code></a>) – The specification of the deployment.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Log</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Log"title="Permalink to this definition">¶</a></dt>
<p>The service that provides logs associated with a task of a given task ID.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dlclass="method">
<dtid="com.vmware.vcenter.lcm_client.Log.get">
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>task_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Log.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the zipped files that contains operation log, serialized task
flow, record of all configuration, and a current status of the
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>task_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmodl.lang_client.ID</span></code> of the operation. must exist in
the server. If for any reason the server reboots during an
operation, all <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmodl.lang_client.ID`s</span><spanclass="pre">previously</span><spanclass="pre">stored</span><spanclass="pre">is</span>
If the given ID does not exist in the server. There might be a
cause of task ID does not exist including, error in taskID, or log
files been purged by system or manually.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Migrate">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Migrate</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Migrate"title="Permalink to this definition">¶</a></dt>
<p>The service to migrate a windows VC to Embedded VCSA, PSC, and Management
VCSA.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>appliance_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType"title="com.vmware.vcenter.lcm_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of appliance to deploy.
If None, defaults to VCSA_EMBEDDED</p></li>
<li><p><strong>appliance_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="com.vmware.vcenter.lcm_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If None, defaults to SMALL</p></li>
<li><p><strong>appliance_disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If None, defaults to REGULAR</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>thin_disk_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVA file.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<li><p><strong>ovftool_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVF Tool.</p></li>
<li><p><strong>ovftool_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not to verify the SSL thumbprint of OVF
Tool location.
if None, Default to be True.</p></li>
<li><p><strong>ovftool_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of OVF Tool location to be verified.
When ovftoolLocationSslVerify is set to False, this field can be
omitted.</p></li>
<li><p><strong>active_directory_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the Active Directory domain to which the source Windows
installation is joined. If the source Windows installation is not
joined to an Active Directory domain, omit this parameter.
Not required when active directory is not applicable</p></li>
<li><p><strong>active_directory_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Administrator user name of the Active Directory domain to which the
source Windows installation is joined. The format can be either
‘username’ or ‘username\@domain’
Not required when active directory is not applicable</p></li>
<li><p><strong>active_directory_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Password for the active directory user.
Not required when active directory is not applicable</p></li>
<li><p><strong>services</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService"title="com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpgradeDestinationApplianceService</span></code></a>) – Spec to configure vCenter server services.</p></li>
<li><p><strong>temporary_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork"title="com.vmware.vcenter.lcm_client.TemporaryNetwork"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TemporaryNetwork</span></code></a>) – The network settings of the appliance to be deployed.</p></li>
<li><p><strong>history</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.History"title="com.vmware.vcenter.lcm_client.History"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">History</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – History data to be included in the upgrade and migrate
Default value will be applied when absent</p></li>
<li><p><strong>ovftool_arguments</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The OVF Tool arguments to be included.
Not required when no OVF Tool argument to pass through</p></li>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.CeipOnlySso"title="com.vmware.vcenter.lcm_client.CeipOnlySso"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CeipOnlySso</span></code></a>) – Spec used to configure an embedded vCenter Server. This field
describes how the embedded vCenter Server appliance should be
configured.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.VCSA_EMBEDDED</span></code></a>.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.CeipOnlySso"title="com.vmware.vcenter.lcm_client.CeipOnlySso"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CeipOnlySso</span></code></a>) – Spec used to configure a Platform Services Controller. This section
describes how the Platform Services Controller appliance should be
configured. If unset, either <codeclass="docutils literal notranslate"><spanclass="pre">vcsaEmbedded</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaExternal</span></code>
must be provided.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.PSC"title="com.vmware.vcenter.lcm_client.ApplianceType.PSC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.PSC</span></code></a>.</p></li>
<p>Spec to describe the configuration parameters that are required for
migrating a Windows vCenter Server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DestinationLocation"title="com.vmware.vcenter.lcm_client.DestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Migrate.MigrateDestinationAppliance"title="com.vmware.vcenter.lcm_client.Migrate.MigrateDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.MigrateDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<li><p><strong>source_vc_windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVcWindows"title="com.vmware.vcenter.lcm_client.SourceVcWindows"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVcWindows</span></code></a>) – Spec to describe the existing Windows vCenter server to migrate.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"title="com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExistingMigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to describe the attributes of a running Migration Assistant on
the Windows vCenter server.
Only applicable when migration assistant is already running on the
source appliance</p></li>
<li><p><strong>start_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.MigrationAssistant"title="com.vmware.vcenter.lcm_client.MigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to automate the invocation of Migration Assistant. Automatic
invocation works only if the source Windows installation is running
as a virtual machine.
Only applicable when migration assistant is not running on the
source appliance.</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the source vSphere Update Manager (VUM)
which you want to upgrade.
Not applicable for appliance not having source vSphere Update
<codeclass="descname">check_task</code><spanclass="sig-paren">(</span><em>spec</em>, <em>options=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Migrate.check_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Performs a precheck for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Migrate.Spec"title="com.vmware.vcenter.lcm_client.Migrate.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.Spec</span></code></a>) – The specification of the deployment.</p></li>
<li><p><strong>options</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DeploymentOption"title="com.vmware.vcenter.lcm_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The deployment precheck options.</p></li>
<codeclass="descname">start_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Migrate.start_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys the appliance for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Migrate.Spec"title="com.vmware.vcenter.lcm_client.Migrate.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.Spec</span></code></a>) – The specification of the deployment.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">MigrationAssistant</code><spanclass="sig-paren">(</span><em>source_location=None</em>, <em>settings=None</em>, <em>guest_credentials=None</em>, <em>migration_assistant_installer_location=None</em>, <em>migration_assistant_installer_location_ssl_verify=None</em>, <em>migration_assistant_installer_location_ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.MigrationAssistant"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the migration assistant to be uploaded and started on
source Windows VC.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>settings</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.MigrationAssistantSetting"title="com.vmware.vcenter.lcm_client.MigrationAssistantSetting"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MigrationAssistantSetting</span></code></a>) – Spec to automatically launch the Migration Assistant.</p></li>
<li><p><strong>guest_credentials</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.GuestCredential"title="com.vmware.vcenter.lcm_client.GuestCredential"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GuestCredential</span></code></a>) – Credentials for the Windows system on which the vCenter server is
running.</p></li>
<li><p><strong>migration_assistant_installer_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Installer location of the migration assistant to be uploaded.</p></li>
<li><p><strong>migration_assistant_installer_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether to verify ssl connection.
when SSL thumbprint is provided, SSL verify is not required.</p></li>
<li><p><strong>migration_assistant_installer_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of the source appliance.
if ssl verify is set to False, thumbprint is not required.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">MigrationAssistantSetting</code><spanclass="sig-paren">(</span><em>migrated_ip=None</em>, <em>https_port=None</em>, <em>export_dir=None</em>, <em>service_account_password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.MigrationAssistantSetting"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the setting of migration assistant to be uploaded and
started on source Windows VC.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>migrated_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The IP address of the network adapter that will be migrated. Only
required if the Windows vCenter Server has multiple network
adapters, making its system name resolve to multiple IP addresses.
May not be applicable.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Migration Assistant port number shown in the Migration Assistant
console. The default port is 9123
If None, defaults to 9123</p></li>
<li><p><strong>export_dir</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Directory to export source configuration and data. Optional.
If None, defaults to /var/tmp</p></li>
<li><p><strong>service_account_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The password of the vCenter Server service account. Required only
if the vCenter Server service is running under a non LocalSystem
account.
Service account may not be applicable</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Network">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Network</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>ip_family=None</em>, <em>mode=None</em>, <em>ip=None</em>, <em>dns_servers=None</em>, <em>prefix=None</em>, <em>gateway=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Network"title="Permalink to this definition">¶</a></dt>
<p>Network configuration of the appliance to be deployed.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Primary network identity. Can be either an IP address or a fully
qualified domain name(FQDN).
host name may not be applicable</p></li>
<li><p><strong>ip_family</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.IpType"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.IpType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TemporaryNetwork.IpType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Network IP address family.
<li><p><strong>ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Network IP address. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A comma-separated list of IP addresses of DNS servers. A JSON array
such as [“1.2.3.4”, “127.0.0.1”]. Required for static mode only.
DNS servers must be reachable from the machine that runs CLI
installer
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Network prefix length. Required for static mode only. Remove if the
mode is “dhcp”. 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. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Gateway of the network. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Notification</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>time=None</em>, <em>message=None</em>, <em>resolution=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Notification"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the message.</p></li>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time the notification was raised/found.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if the time information is available.</p></li>
<p>Configuration of the replicated Single Sign-On for PSC type deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator password of the PSC to be replicated.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name of the remote PSC. For example, ‘vsphere.local’</p></li>
<li><p><strong>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the SSL verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is provided, this field can be omitted If
None, defaults to False</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate which will be used
for verification.
If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is set to False, this field can be omitted</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the remote PSC.
If None, defaults to 443</p></li>
<li><p><strong>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site name of the newly deployed PSC.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">PscStandalone</code><spanclass="sig-paren">(</span><em>sso_admin_password=None</em>, <em>sso_domain_name=None</em>, <em>sso_site_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.PscStandalone"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the standalone Single Sign-On for Embedded type
deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name of the newly deployed PSC. For example, ‘vsphere.local’</p></li>
<li><p><strong>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site name of the PSC.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Recommendation</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">DatastoreDestinationAppliance</code><spanclass="sig-paren">(</span><em>appliance_size=None</em>, <em>appliance_disk_size=None</em>, <em>ova_location=None</em>, <em>ova_location_ssl_verify=None</em>, <em>ova_location_ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The configuration of destination appliance to recommend datastore.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="com.vmware.vcenter.lcm_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If None, defaults to SMALL</p></li>
<li><p><strong>appliance_disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If None, defaults to REGULAR</p></li>
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The location of the ova file.
Not required.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<emclass="property">class </em><codeclass="descname">DatastoreDestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the ESX or VC on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreEsx"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreEsx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreEsx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreVc"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreVc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreVc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property">class </em><codeclass="descname">DatastoreEsx</code><spanclass="sig-paren">(</span><em>connection=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreEsx"title="Permalink to this definition">¶</a></dt>
<p>This section describes the ESX host on which to deploy the appliance.
Required if you are deploying the appliance directly on an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p>
<emclass="property">class </em><codeclass="descname">DatastoreInfo</code><spanclass="sig-paren">(</span><em>freespace=None</em>, <em>freespace_after_placement=None</em>, <em>required_space=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreInfo"title="Permalink to this definition">¶</a></dt>
<p>Datastore space information. Space information are in GB unit.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>freespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – The amount of space that the datastore currently has.</p></li>
<li><p><strong>freespace_after_placement</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – The amount of space that the datastore will have after deployment.</p></li>
<li><p><strong>required_space</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – The amount of space that the deployment will occupy.</p></li>
<emclass="property">class </em><codeclass="descname">DatastoreRequest</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreRequest"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationLocation"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreDestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationAppliance"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<emclass="property">class </em><codeclass="descname">DatastoreVc</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreVc"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the vCenter on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreVcInventory"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreVcInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreVcInventory</span></code></a>) – 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’. You must
always provide the ‘network_name’ key. To install a new appliance
to a specific ESX host in a cluster, provide the ‘host_path’ key,
<emclass="property">class </em><codeclass="descname">DatastoreVcInventory</code><spanclass="sig-paren">(</span><em>host_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreVcInventory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">DeploymentSizeDestinationAppliance</code><spanclass="sig-paren">(</span><em>ova_location=None</em>, <em>ova_location_ssl_verify=None</em>, <em>ova_location_ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The location of the ova file.
Not required.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<emclass="property">class </em><codeclass="descname">MigrateDeploymentSizeRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em>, <em>source_vc_windows=None</em>, <em>existing_migration_assistant=None</em>, <em>start_migration_assistant=None</em>, <em>source_vum_location=None</em>, <em>source_vum=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.MigrateDeploymentSizeRequest"title="Permalink to this definition">¶</a></dt>
<p>The request for recommending migrate deployment size.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"title="com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DeploymentSizeDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<li><p><strong>source_vc_windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVcWindows"title="com.vmware.vcenter.lcm_client.SourceVcWindows"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVcWindows</span></code></a>) – Spec to describe the existing Windows vCenter server to migrate.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"title="com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExistingMigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to describe the attributes of a running Migration Assistant on
the Windows vCenter server.
Only applicable when migration assistant is already running on the
source appliance</p></li>
<li><p><strong>start_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.MigrationAssistant"title="com.vmware.vcenter.lcm_client.MigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to automate the invocation of Migration Assistant. Automatic
invocation works only if the source Windows installation is running
as a virtual machine.
Only applicable when migration assistant is not running on the
source appliance.</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the source vSphere Update Manager (VUM)
which you want to upgrade.
Not applicable for appliance not having source vSphere Update
<emclass="property">class </em><codeclass="descname">UpgradeDeploymentSizeRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em>, <em>source_location=None</em>, <em>source_appliance=None</em>, <em>source_vum=None</em>, <em>source_vum_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.UpgradeDeploymentSizeRequest"title="Permalink to this definition">¶</a></dt>
<p>The request for recommending upgrade deployment size.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"title="com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DeploymentSizeDestinationAppliance</span></code></a>) – Spec to describe the new appliance</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.UpgradeSourceAppliance"title="com.vmware.vcenter.lcm_client.UpgradeSourceAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpgradeSourceAppliance</span></code></a>) – Spec to describe the existing appliance to upgrade.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the source vSphere Update Manager (VUM)
which you want to upgrade.
Not applicable for appliance not having source vSphere Update
Manager</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<codeclass="descname">scan_datastore_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.scan_datastore_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Recommend a datastore for the appliance to be deployed in.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DatastoreRequest"title="com.vmware.vcenter.lcm_client.Recommendation.DatastoreRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DatastoreRequest</span></code></a>) – The specification contains the information needed to recommend
<codeclass="descname">scan_migrate_deployment_size_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.scan_migrate_deployment_size_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Recommend deployment sizes based on the configuration given in the
specification.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.MigrateDeploymentSizeRequest"title="com.vmware.vcenter.lcm_client.Recommendation.MigrateDeploymentSizeRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.MigrateDeploymentSizeRequest</span></code></a>) – The specification that contains information needed to recommend
<codeclass="descname">scan_upgrade_deployment_size_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Recommendation.scan_upgrade_deployment_size_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Recommend deployment sizes based on the configuration given in the
specification.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.UpgradeDeploymentSizeRequest"title="com.vmware.vcenter.lcm_client.Recommendation.UpgradeDeploymentSizeRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.UpgradeDeploymentSizeRequest</span></code></a>) – The specification that contains information needed to recommend
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Result</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>warnings=None</em>, <em>errors=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Result"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">SourceVcWindows</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>username=None</em>, <em>password=None</em>, <em>ssl_verify=None</em>, <em>ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.SourceVcWindows"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or FQDN of the source Windows vCenter server to
migrate. If an FQDN is provided, it must be resolvable from the
machine that is running the installer.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Single Sign-On administrator user on the source Windows vCenter
server. For example, administrator\@vsphere.local. Important:
The user must be administrator\@your_domain_name.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the Single Sign-On administrator on the source
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address or fully qualified domain name (FQDN) of the vSphere
Update Manager host. If an FQDN is provided, it has to be
resolvable from the machine that is running the installer.</p></li>
<li><p><strong>os_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator username for the source vSphere Update Manager
Windows operating system.</p></li>
<li><p><strong>os_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Administrator user password for the source vSphere Update Manager
Windows operating system.</p></li>
<li><p><strong>export_dir</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Directory to export source configuration and data.
If None, defaults to for mac/lin: /var/tmp, for windows: %TEMP%</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The port of the source vum.
default to be 9123</p></li>
<li><p><strong>start_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVumMigrationAssistant"title="com.vmware.vcenter.lcm_client.SourceVumMigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVumMigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration of migration assistant to be deployed to the vSphere
Upgrade Manager.
Mutually exclusive between start migration assistant and existing
migration assistant.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"title="com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExistingMigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration of migration assistant that are already running on
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">SourceVumMigrationAssistant</code><spanclass="sig-paren">(</span><em>installer_location=None</em>, <em>installer_location_ssl_verify=None</em>, <em>installer_location_ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.SourceVumMigrationAssistant"title="Permalink to this definition">¶</a></dt>
<p>Configuration of migration assistant to be deployed to the vSphere Upgrade
Manager.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>installer_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Location of the installer of migration assistant to be uploaded to
the source vSphere Update Manager.
Mutually exclusive between start migration assistant and existing
migration assistant.</p></li>
<li><p><strong>installer_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether to verify ssl connection of the location
of the installer of migration assistant.
when SSL thumbprint is provided, SSL verify is not required.</p></li>
<li><p><strong>installer_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of the location of the installer of migration
assistant.
if ssl verify is set to False, thumbprint is not required.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Ssh">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Ssh</code><spanclass="sig-paren">(</span><em>enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Ssh"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">StorageSize</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.StorageSize"title="Permalink to this definition">¶</a></dt>
<p>The storage size of the appliance to be deployed.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> instance.</p>
<codeclass="descname">LARGE</code><emclass="property"> = StorageSize(string='LARGE')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.StorageSize.LARGE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">REGULAR</code><emclass="property"> = StorageSize(string='REGULAR')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.StorageSize.REGULAR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">XLARGE</code><emclass="property"> = StorageSize(string='XLARGE')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.StorageSize.XLARGE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<p>Container that contains the status information about a single task.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this deployment task.</p></li>
<li><p><strong>last_updated_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The time that the last update is registered.</p></li>
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Result"title="com.vmware.vcenter.lcm_client.Result"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Result</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the task.
This attribute will be None if result is not available at the
current step of the task.</p></li>
<li><p><strong>external_tools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExternalTool"title="com.vmware.vcenter.lcm_client.ExternalTool"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalTool</span></code></a>) – External tools used for the deployment.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
<p>The container that contains the status information of a deployment.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>metadata_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The path of the metadata file.</p></li>
<li><p><strong>state</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The state of appliance being deployed.
May not have any state information.</p></li>
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The total progress of the deployment operation.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of
<li><p><strong>last_updated_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The time that the last update is registered.</p></li>
<li><p><strong>subtask_order</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ordered list of subtasks for this deployment operation.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> when the appliance state is RUNNING_IN_PROGRESS,
FAILED, CANCELLED and SUCCEEDED.</p></li>
<li><p><strong>subtasks</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SubTaskInfo"title="com.vmware.vcenter.lcm_client.SubTaskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubTaskInfo</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map of the deployment subtasks and their status information.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> when the appliance state is RUNNING_IN_PROGRESS,
FAILED, CANCELLED and SUCCEEDED.</p></li>
<li><p><strong>appliance_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DeploymentInfo"title="com.vmware.vcenter.lcm_client.DeploymentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the appliance deployed.
Such information may not be available for requests that are not for
deployment (validation/recommendation).</p></li>
<li><p><strong>result</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataValue</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The result of validation or recommendation requests.
Not applicable for precheck/deployment operation.</p></li>
<li><p><strong>additional_info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional information that a response may contain.
Not all response will contain additional information.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">TemporaryNetwork</code><spanclass="sig-paren">(</span><em>ip_family=None</em>, <em>mode=None</em>, <em>ip=None</em>, <em>dns_servers=None</em>, <em>prefix=None</em>, <em>gateway=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork"title="Permalink to this definition">¶</a></dt>
<li><p><strong>ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Network IP address. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A comma-separated list of IP addresses of DNS servers. A JSON array
such as [“1.2.3.4”, “127.0.0.1”]. Required for static mode only.
DNS servers must be reachable from the machine that runs CLI
installer
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Network prefix length. Required for static mode only. Remove if the
mode is “dhcp”. 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. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<li><p><strong>gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Gateway of the network. Required for static mode only.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TemporaryNetwork.NetworkMode.STATIC</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descname">IpType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.IpType"title="Permalink to this definition">¶</a></dt>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpType</span></code> instance.</p>
<codeclass="descname">IPV4</code><emclass="property"> = IpType(string='IPV4')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.IpType.IPV4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">IPV6</code><emclass="property"> = IpType(string='IPV6')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.IpType.IPV6"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">NetworkMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode"title="Permalink to this definition">¶</a></dt>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkMode</span></code> instance.</p>
<codeclass="descname">DHCP</code><emclass="property"> = NetworkMode(string='DHCP')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.DHCP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATIC</code><emclass="property"> = NetworkMode(string='STATIC')</em><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork.NetworkMode.STATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Static IP mode.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Time">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Time</code><spanclass="sig-paren">(</span><em>ntp_servers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Time"title="Permalink to this definition">¶</a></dt>
<p>NTP setting of the appliance to be deployed.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – To configure NTP time synchronization for the appliance, set the
value to a comma - separated list of host names or IP addresses of
Network Time Protocol(NTP) servers. If “ntp_servers” is not
provided, the appliance clock will be synced to the ESX. For
example: [“time.nist.gov”].
Times tool sync will be enabled when ntp server is not provided. If
None, defaults to []</p>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Upgrade">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Upgrade</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Upgrade"title="Permalink to this definition">¶</a></dt>
<p>The service to upgrade an existing appliance to Embedded VCSA, PSC, and
Management VCSA.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Spec</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>destination_appliance=None</em>, <em>source_location=None</em>, <em>source_appliance=None</em>, <em>source_vum=None</em>, <em>source_vum_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Upgrade.Spec"title="Permalink to this definition">¶</a></dt>
<p>Spec to describe the configuration parameters that are required for upgrade
of a vCenter Server Appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DestinationLocation"title="com.vmware.vcenter.lcm_client.DestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Upgrade.UpgradeDestinationAppliance"title="com.vmware.vcenter.lcm_client.Upgrade.UpgradeDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.UpgradeDestinationAppliance</span></code></a>) – Spec to describe the new appliance</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.UpgradeSourceAppliance"title="com.vmware.vcenter.lcm_client.UpgradeSourceAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpgradeSourceAppliance</span></code></a>) – Spec to describe the existing appliance to upgrade.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the source vSphere Update Manager (VUM)
which you want to upgrade.
Not applicable for appliance not having source vSphere Update
Manager</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>appliance_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType"title="com.vmware.vcenter.lcm_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a>) – The type of appliance to deploy.</p></li>
<li><p><strong>appliance_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="com.vmware.vcenter.lcm_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If None, defaults to SMALL</p></li>
<li><p><strong>appliance_disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If None, defaults to REGULAR</p></li>
<li><p><strong>thin_disk_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVA file.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<li><p><strong>ovftool_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The location of the OVF Tool.</p></li>
<li><p><strong>ovftool_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not to verify the SSL thumbprint of OVF
Tool location.
Default to be True.</p></li>
<li><p><strong>ovftool_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of OVF Tool location to be verified.
When <codeclass="docutils literal notranslate"><spanclass="pre">ovftoolLocationSslVerify</span></code> is set to False, this field can
be omitted.</p></li>
<li><p><strong>services</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService"title="com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpgradeDestinationApplianceService</span></code></a>) – Spec to configure vCenter server services.</p></li>
<li><p><strong>temporary_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork"title="com.vmware.vcenter.lcm_client.TemporaryNetwork"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TemporaryNetwork</span></code></a>) – The network settings of the appliance to be deployed.</p></li>
<li><p><strong>history</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.History"title="com.vmware.vcenter.lcm_client.History"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">History</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – History data to be included in the upgrade and migrate
Default value will be applied when absent</p></li>
<li><p><strong>ovftool_arguments</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The OVF Tool arguments to be included.
Not required when no OVF Tool argument to pass through</p></li>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.CeipOnlySso"title="com.vmware.vcenter.lcm_client.CeipOnlySso"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CeipOnlySso</span></code></a>) – Spec used to configure an embedded vCenter Server. This field
describes how the embedded vCenter Server appliance should be
configured.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.lcm_client.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.VCSA_EMBEDDED</span></code></a>.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.CeipOnlySso"title="com.vmware.vcenter.lcm_client.CeipOnlySso"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CeipOnlySso</span></code></a>) – Spec used to configure a Platform Services Controller. This section
describes how the Platform Services Controller appliance should be
configured. If unset, either <codeclass="docutils literal notranslate"><spanclass="pre">vcsaEmbedded</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaExternal</span></code>
must be provided.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">applianceType</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType.PSC"title="com.vmware.vcenter.lcm_client.ApplianceType.PSC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ApplianceType.PSC</span></code></a>.</p></li>
<codeclass="descname">check_task</code><spanclass="sig-paren">(</span><em>spec</em>, <em>options=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Upgrade.check_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Performs a precheck for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Upgrade.Spec"title="com.vmware.vcenter.lcm_client.Upgrade.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.Spec</span></code></a>) – The specification of the deployment.</p></li>
<li><p><strong>options</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.DeploymentOption"title="com.vmware.vcenter.lcm_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The deployment precheck options.</p></li>
<codeclass="descname">start_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Upgrade.start_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys the appliance for the given specification. The result of this
operation can be queried by calling the cis/tasks/{task-id} with the
task-id in the response of this call.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Upgrade.Spec"title="com.vmware.vcenter.lcm_client.Upgrade.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.Spec</span></code></a>) – The specification of the deployment.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">UpgradeDestinationApplianceService</code><spanclass="sig-paren">(</span><em>ssh=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the source appliance to be upgraded/migrated.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or fully qualified domain name (FQDN) of the vCenter
Server instance. If an FQDN is provided, it has to be resolvable
from the machine that is running the installer.</p></li>
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – vCenter Single Sign-On administrator user name of the source
appliance.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – vCenter Single Sign-On administrator password of the source
appliance.</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password of the operating system root user of the appliance.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port number to connect to the source appliance.
<li><p><strong>export_dir</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Export directory of the source appliance.
Default to be “/var/tmp/”.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.lcm_client.Validation">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Validation</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation"title="Permalink to this definition">¶</a></dt>
<p>The service that provides validation of a section of full deployment
specification.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">ApplianceNameDestinationAppliance</code><spanclass="sig-paren">(</span><em>appliance_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>Data container for appliance name information used in validation of
appliance name request.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p>
<emclass="property">class </em><codeclass="descname">ApplianceNameDestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameEsx"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameEsx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameEsx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameVc"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameVc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameVc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property">class </em><codeclass="descname">ApplianceNameEsx</code><spanclass="sig-paren">(</span><em>connection=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameEsx"title="Permalink to this definition">¶</a></dt>
<p>This section describes the ESX host on which to deploy the appliance.
Required if you are deploying the appliance directly on an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p>
<emclass="property">class </em><codeclass="descname">ApplianceNameEsxInventory</code><spanclass="sig-paren">(</span><em>resource_pool_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameEsxInventory"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The path to the resource pool on the ESX host in which the
<emclass="property">class </em><codeclass="descname">ApplianceNameRequest</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameRequest"title="Permalink to this definition">¶</a></dt>
<p>Data container that contains the information needed to validate appliance
name.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationLocation"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameDestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<emclass="property">class </em><codeclass="descname">ApplianceNameVc</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameVc"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the vCenter on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameVcInventory"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameVcInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameVcInventory</span></code></a>) – 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’. You must
always provide the ‘network_name’ key. To install a new appliance
to a specific ESX host in a cluster, provide the ‘host_path’ key,
<emclass="property">class </em><codeclass="descname">ApplianceNameVcInventory</code><spanclass="sig-paren">(</span><em>vm_folder_path=None</em>, <em>resource_pool_path=None</em>, <em>cluster_path=None</em>, <em>host_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameVcInventory"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to resource pool. Format: /{datacenter
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>cluster_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to the cluster. Format: /{datacenter folder}/{datacenter
<emclass="property">class </em><codeclass="descname">ContainerWithoutInventory</code><spanclass="sig-paren">(</span><em>connection=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ContainerWithoutInventory"title="Permalink to this definition">¶</a></dt>
<p>This section describes the ESX host on which to deploy the appliance.
Required if you are deploying the appliance directly on an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p>
<emclass="property">class </em><codeclass="descname">DestinationLocationEsx</code><spanclass="sig-paren">(</span><em>connection=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationEsx"title="Permalink to this definition">¶</a></dt>
<p>This section describes the ESX host on which to deploy the appliance.
Required if you are deploying the appliance directly on an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p>
<emclass="property">class </em><codeclass="descname">DestinationLocationRequest</code><spanclass="sig-paren">(</span><em>destination_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationRequest"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">DestinationLocationVc</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationVc"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the vCenter on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.VcInventory"title="com.vmware.vcenter.lcm_client.VcInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VcInventory</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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’. You must
always provide the ‘network_name’ key. To install a new appliance
to a specific ESX host in a cluster, provide the ‘host_path’ key,
<emclass="property">class </em><codeclass="descname">EsxDestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.EsxDestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the ESX or VC on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ContainerWithoutInventory"title="com.vmware.vcenter.lcm_client.Validation.ContainerWithoutInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ContainerWithoutInventory</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ContainerWithoutInventory"title="com.vmware.vcenter.lcm_client.Validation.ContainerWithoutInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ContainerWithoutInventory</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property">class </em><codeclass="descname">EsxRequest</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>source_location=None</em>, <em>source_vum_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.EsxRequest"title="Permalink to this definition">¶</a></dt>
<p>The request that contains the information to verify esx management status.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.EsxDestinationLocation"title="com.vmware.vcenter.lcm_client.Validation.EsxDestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.EsxDestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<p>Data container for appliance name information used in validation of
appliance name request.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appliance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the appliance to deploy.</p></li>
<li><p><strong>appliance_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceType"title="com.vmware.vcenter.lcm_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a>) – The type of appliance to deploy.</p></li>
<li><p><strong>appliance_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ApplianceSize"title="com.vmware.vcenter.lcm_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A size descriptor based on the number of virtual machines which
will be managed by the new vCenter appliance.
If None, defaults to SMALL</p></li>
<li><p><strong>appliance_disk_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.StorageSize"title="com.vmware.vcenter.lcm_client.StorageSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageSize</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The disk size of the new vCenter appliance.
If None, defaults to REGULAR</p></li>
<li><p><strong>thin_disk_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to deploy the appliance with thin mode virtual disks.</p></li>
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The location of the ova file.
Not required.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<emclass="property">class </em><codeclass="descname">HostConfigDestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigDestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the ESX or VC on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigEsx"title="com.vmware.vcenter.lcm_client.Validation.HostConfigEsx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigEsx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigVc"title="com.vmware.vcenter.lcm_client.Validation.HostConfigVc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigVc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<emclass="property">class </em><codeclass="descname">HostConfigEsx</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigEsx"title="Permalink to this definition">¶</a></dt>
<p>This section describes the ESX host on which to deploy the appliance.
Required if you are deploying the appliance directly on an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigEsxInventory"title="com.vmware.vcenter.lcm_client.Validation.HostConfigEsxInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigEsxInventory</span></code></a>) – The configuration of ESX inventory.</p></li>
<emclass="property">class </em><codeclass="descname">HostConfigEsxInventory</code><spanclass="sig-paren">(</span><em>datastore_name=None</em>, <em>resource_pool_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigEsxInventory"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must be accessible
from the ESX host and must have at least 25 GB of free space.
Otherwise, the new appliance might not power on.</p></li>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The path to the resource pool on the ESX host in which the
<emclass="property">class </em><codeclass="descname">HostConfigRequest</code><spanclass="sig-paren">(</span><em>destination_location=None</em>, <em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigRequest"title="Permalink to this definition">¶</a></dt>
<p>Data container that contains the information needed to validate appliance
name.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigDestinationLocation"title="com.vmware.vcenter.lcm_client.Validation.HostConfigDestinationLocation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigDestinationLocation</span></code></a>) – This subsection describes the ESX or VC on which to deploy the
appliance.</p></li>
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.HostConfigDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<emclass="property">class </em><codeclass="descname">HostConfigVc</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigVc"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the vCenter on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigVcInventory"title="com.vmware.vcenter.lcm_client.Validation.HostConfigVcInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigVcInventory</span></code></a>) – 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’. You must
always provide the ‘network_name’ key. To install a new appliance
to a specific ESX host in a cluster, provide the ‘host_path’ key,
<emclass="property">class </em><codeclass="descname">HostConfigVcInventory</code><spanclass="sig-paren">(</span><em>vm_folder_path=None</em>, <em>resource_pool_path=None</em>, <em>cluster_path=None</em>, <em>host_path=None</em>, <em>datastore_name=None</em>, <em>datastore_cluster_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigVcInventory"title="Permalink to this definition">¶</a></dt>
To place a new appliance to a virtual machine Folder, provide the
‘vm_folder_path’, e.g. ‘vm_folder_path’: ‘VM Folder 0/VM Folder1’.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_folder_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Path of the VM folder. VM folder must be visible by the Data Center
of the compute resourceFormat:{vm_folder1}/{vm_folder2}e.g.:’VM
Folder 0/VM Folder1’.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to resource pool. Format: /{datacenter
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>cluster_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to the cluster. Format: /{datacenter folder}/{datacenter
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must be accessible
from the ESX host and must have at least 25 GB of free space.
Otherwise, the new appliance might not power on.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<li><p><strong>datastore_cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore cluster on which to store the files of the appliance.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<emclass="property">class </em><codeclass="descname">MigrateSourceApplianceRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em>, <em>source_vc_windows=None</em>, <em>existing_migration_assistant=None</em>, <em>start_migration_assistant=None</em>, <em>source_vum_location=None</em>, <em>source_vum=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.MigrateSourceApplianceRequest"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the ESX or VC on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"title="com.vmware.vcenter.lcm_client.Recommendation.DeploymentSizeDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendation.DeploymentSizeDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<li><p><strong>source_vc_windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVcWindows"title="com.vmware.vcenter.lcm_client.SourceVcWindows"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVcWindows</span></code></a>) – Spec to describe the existing Windows vCenter server to migrate.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"title="com.vmware.vcenter.lcm_client.ExistingMigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExistingMigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to describe the attributes of a running Migration Assistant on
the Windows vCenter server.
Only applicable when migration assistant is already running on the
source appliance</p></li>
<li><p><strong>start_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.MigrationAssistant"title="com.vmware.vcenter.lcm_client.MigrationAssistant"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MigrationAssistant</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to automate the invocation of Migration Assistant. Automatic
invocation works only if the source Windows installation is running
as a virtual machine.
Only applicable when migration assistant is not running on the
source appliance.</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the source vSphere Update Manager (VUM)
which you want to upgrade.
Not applicable for appliance not having source vSphere Update
<emclass="property">class </em><codeclass="descname">NetworkDestinationAppliance</code><spanclass="sig-paren">(</span><em>network=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.NetworkDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Network"title="com.vmware.vcenter.lcm_client.Network"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network</span></code></a>) – The network settings of the appliance to be deployed.</p>
<emclass="property">class </em><codeclass="descname">NetworkRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.NetworkRequest"title="Permalink to this definition">¶</a></dt>
<p>The request that contains network information to be validated.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.NetworkDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.NetworkDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.NetworkDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p>
<emclass="property">class </em><codeclass="descname">NtpServerDestinationAppliance</code><spanclass="sig-paren">(</span><em>time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.NtpServerDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>time</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Time"title="com.vmware.vcenter.lcm_client.Time"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Time</span></code></a>) – Configuration of the vCSA time synchronization.</p>
<emclass="property">class </em><codeclass="descname">NtpServerRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.NtpServerRequest"title="Permalink to this definition">¶</a></dt>
<p>A request that contains the information needed to validate the given ntp
servers.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.NtpServerDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.NtpServerDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.NtpServerDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p>
<emclass="property">class </em><codeclass="descname">OsPasswordDestinationAppliance</code><spanclass="sig-paren">(</span><em>root_password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.OsPasswordDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password must conform to the following requirements: 1. At least 8
characters. 2. No more than 20 characters. 3. At least 1 uppercase
character. 4. At least 1 lowercase character. 5. At least 1 number.
6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7.
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)</p>
<emclass="property">class </em><codeclass="descname">OsPasswordRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.OsPasswordRequest"title="Permalink to this definition">¶</a></dt>
<p>The request that contains information needed to verify the given password
conforms password policy.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.OsPasswordDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.OsPasswordDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.OsPasswordDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p>
<emclass="property">class </em><codeclass="descname">SourceLocationRequest</code><spanclass="sig-paren">(</span><em>source_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SourceLocationRequest"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">SourceVumRequest</code><spanclass="sig-paren">(</span><em>source_vc_windows=None</em>, <em>source_appliance=None</em>, <em>source_vum_location=None</em>, <em>source_vum=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumRequest"title="Permalink to this definition">¶</a></dt>
<p>The request that contains information needed to verify the credentials of
source vSphere Update Manager and run the migration assistant.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>source_vc_windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumSourceVcWindows"title="com.vmware.vcenter.lcm_client.Validation.SourceVumSourceVcWindows"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.SourceVumSourceVcWindows</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec to describe the existing Windows vCenter server to migrate.</p></li>
<li><p><strong>source_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumUpgradeSourceAppliance"title="com.vmware.vcenter.lcm_client.Validation.SourceVumUpgradeSourceAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.SourceVumUpgradeSourceAppliance</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Source appliance configuration for upgrade service.</p></li>
<li><p><strong>source_vum_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>source_vum</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.SourceVum"title="com.vmware.vcenter.lcm_client.SourceVum"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceVum</span></code></a>) – This section describes the source vSphere Update Manager (VUM)
<emclass="property">class </em><codeclass="descname">SourceVumSourceVcWindows</code><spanclass="sig-paren">(</span><em>username=None</em>, <em>password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumSourceVcWindows"title="Permalink to this definition">¶</a></dt>
<p>Spec to describe the existing Windows vCenter server to migrate.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Single Sign-On administrator user on the source Windows vCenter
server. For example, administrator\@vsphere.local. Important:
The user must be administrator\@your_domain_name.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the Single Sign-On administrator on the source
<emclass="property">class </em><codeclass="descname">SourceVumUpgradeSourceAppliance</code><spanclass="sig-paren">(</span><em>sso_admin_username=None</em>, <em>sso_admin_password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumUpgradeSourceAppliance"title="Permalink to this definition">¶</a></dt>
<p>Source appliance configuration for upgrade service.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – vCenter Single Sign-On administrator user name of the source
appliance.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – vCenter Single Sign-On administrator password of the source
<emclass="property">class </em><codeclass="descname">SsoConfigurationDestinationAppliance</code><spanclass="sig-paren">(</span><em>vcsa_embedded=None</em>, <em>psc=None</em>, <em>vcsa_external=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationVcsaEmbedded"title="com.vmware.vcenter.lcm_client.Validation.SsoConfigurationVcsaEmbedded"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.SsoConfigurationVcsaEmbedded</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration of Single Sign-On for deploying Embedded.
Mutuall exclusive between embedded, PSC, and management node.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationPsc"title="com.vmware.vcenter.lcm_client.Validation.SsoConfigurationPsc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.SsoConfigurationPsc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration of Single Sign-On for deploying PSC.
Mutuall exclusive between embedded, PSC, and management node.</p></li>
<li><p><strong>vcsa_external</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.ExternalVcsa"title="com.vmware.vcenter.lcm_client.ExternalVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalVcsa</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration of Single Sign-On for deploying management node.
Mutuall exclusive between embedded, PSC, and management node.</p></li>
<emclass="property">class </em><codeclass="descname">SsoConfigurationPsc</code><spanclass="sig-paren">(</span><em>standalone=None</em>, <em>replicated=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationPsc"title="Permalink to this definition">¶</a></dt>
<p>Spec used to configure a Platform Services Controller. This section
describes how the Platform Services Controller appliance should be
configured. If unset, either <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaEmbedded</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">#vcsaExternal</span></code> must be
provided.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.PscStandalone"title="com.vmware.vcenter.lcm_client.PscStandalone"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PscStandalone</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone Platform Services Controller.
This section describes how the standalone PSC should be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.PscReplicated"title="com.vmware.vcenter.lcm_client.PscReplicated"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PscReplicated</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated Platform Services Controller.
This section describes how the replicated PSC should be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<emclass="property">class </em><codeclass="descname">SsoConfigurationRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationRequest"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">SsoConfigurationVcsaEmbedded</code><spanclass="sig-paren">(</span><em>standalone=None</em>, <em>replicated=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.SsoConfigurationVcsaEmbedded"title="Permalink to this definition">¶</a></dt>
<p>Spec used to configure an embedded vCenter Server. This field describes how
the embedded vCenter Server appliance should be configured.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa"title="com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EmbeddedStandaloneVcsa</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone embedded vCenter Server. This
field describes how the standalone vCenter Server appliance should
be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa"title="com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EmbeddedReplicatedVcsa</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated embedded vCenter Server. This
field describes how the replicated vCenter Server appliance should
be configured.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">standalone</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">replicated</span></code></p></li>
<emclass="property">class </em><codeclass="descname">TemporaryNetworkDestinationAppliance</code><spanclass="sig-paren">(</span><em>network=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.TemporaryNetwork"title="com.vmware.vcenter.lcm_client.TemporaryNetwork"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TemporaryNetwork</span></code></a>) – The network settings of the appliance to be deployed.</p>
<emclass="property">class </em><codeclass="descname">TemporaryNetworkRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkRequest"title="Permalink to this definition">¶</a></dt>
<p>The request that contains network information to be validated.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.TemporaryNetworkDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p>
<emclass="property">class </em><codeclass="descname">UpgradeSourceApplianceDestinationAppliance</code><spanclass="sig-paren">(</span><em>ova_location=None</em>, <em>ova_location_ssl_verify=None</em>, <em>ova_location_ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceDestinationAppliance"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ova_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The location of the ova file.
Not required.</p></li>
<li><p><strong>ova_location_ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to indicate whether the ssl verification is required.
If <codeclass="docutils literal notranslate"><spanclass="pre">ovaLocationSslThumbprint</span></code> is provided, this field can be
omitted If None, defaults to True</p></li>
<li><p><strong>ova_location_ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL thumbprint of ssl verification. If provided, ssl_verify can be
omitted or set to true. If omitted, ssl_verify must be false. If
omitted and ssl_verify is true, an error will occur.
If ova_location_ssl_verify is False, this field can be omitted</p></li>
<emclass="property">class </em><codeclass="descname">UpgradeSourceApplianceRequest</code><spanclass="sig-paren">(</span><em>destination_appliance=None</em>, <em>source_appliance=None</em>, <em>source_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceRequest"title="Permalink to this definition">¶</a></dt>
<p>The configuration to validate source appliance for upgrade.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>destination_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceDestinationAppliance"title="com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceDestinationAppliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.UpgradeSourceApplianceDestinationAppliance</span></code></a>) – Spec to describe the new appliance.</p></li>
<emclass="property">class </em><codeclass="descname">ValidationDestinationLocation</code><spanclass="sig-paren">(</span><em>esx=None</em>, <em>vcenter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.ValidationDestinationLocation"title="Permalink to this definition">¶</a></dt>
<p>This subsection describes the ESX or VC on which to deploy the appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>esx</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationEsx"title="com.vmware.vcenter.lcm_client.Validation.DestinationLocationEsx"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.DestinationLocationEsx</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This section describes the ESX host on which to deploy the
appliance. Required if you are deploying the appliance directly on
an ESX host.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<li><p><strong>vcenter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationVc"title="com.vmware.vcenter.lcm_client.Validation.DestinationLocationVc"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.DestinationLocationVc</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This subsection describes the vCenter on which to deploy the
appliance.
Mutual exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">esx</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">vcenter</span></code></p></li>
<codeclass="descname">check_appliance_name_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_appliance_name_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the name of the appliance to be deployed.</p>
<olclass="arabic simple">
<li><p>1. Return False if the there is already an appliance that has the
same name as given in the spec exist in the path.</p></li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.ApplianceNameRequest"title="com.vmware.vcenter.lcm_client.Validation.ApplianceNameRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.ApplianceNameRequest</span></code></a>) – The configuration needed to validate the name of the appliance to
<codeclass="descname">check_destination_location_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_destination_location_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the ESX of the appliance to be deployed.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.DestinationLocationRequest"title="com.vmware.vcenter.lcm_client.Validation.DestinationLocationRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.DestinationLocationRequest</span></code></a>) – The configuration needed to validate the ESX of the appliance to be
<codeclass="descname">check_host_config_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_host_config_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the host configuration.</p>
<olclass="arabic simple">
<li><p>1. Return False if the provided appliance type, appliance size, and
disk size combination is not valid.</p></li>
<li><p>2. Return False if the provided deployment path does not have
sufficient memory allocated.</p></li>
<li><p>3. Return False if the provided deployment path does not have
sufficient cpu allocated.</p></li>
<li><p>3. Return False if the provided deployment path does not have
sufficient datastore space.</p></li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.HostConfigRequest"title="com.vmware.vcenter.lcm_client.Validation.HostConfigRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.HostConfigRequest</span></code></a>) – The configuration needed to validate host configuration.</p>
<codeclass="descname">check_migrate_source_appliance_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_migrate_source_appliance_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the source appliance to be migrated.</p>
<olclass="arabic simple">
<li><p>1. Return False if the provided source windows vc credentials are
incorrect</p></li>
<li><olclass="arabic simple"start="2">
<li><p>Return False if migration assistant precheck results in error.</p></li>
</ol>
</li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.MigrateSourceApplianceRequest"title="com.vmware.vcenter.lcm_client.Validation.MigrateSourceApplianceRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.MigrateSourceApplianceRequest</span></code></a>) – The configuration of the source appliance to be migrated.</p>
<codeclass="descname">check_network_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_network_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if the given network configuration is valid.</p>
<olclass="arabic simple">
<li><olclass="arabic simple">
<li><p>Return False if the given network will cause conflict.</p></li>
</ol>
</li>
<li><olclass="arabic simple"start="2">
<li><p>Always return True if network mode is set to DHCP.</p></li>
</ol>
</li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.NetworkRequest"title="com.vmware.vcenter.lcm_client.Validation.NetworkRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.NetworkRequest</span></code></a>) – The configuration needed to validate network.</p>
<codeclass="descname">check_os_password_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_os_password_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate if the given password conforms password policy.</p>
<olclass="arabic simple">
<li><olclass="arabic simple">
<li><p>Return False if the password in the spec violates password policy</p></li>
</ol>
</li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.OsPasswordRequest"title="com.vmware.vcenter.lcm_client.Validation.OsPasswordRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.OsPasswordRequest</span></code></a>) – The configuration needed to validate the given password against
<codeclass="descname">check_source_vum_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_source_vum_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the source VUM configuration.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.SourceVumRequest"title="com.vmware.vcenter.lcm_client.Validation.SourceVumRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.SourceVumRequest</span></code></a>) – The configuration needed to validate the source VUM.</p>
<codeclass="descname">check_temporary_network_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_temporary_network_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if the given network configuration is valid.</p>
<olclass="arabic simple">
<li><olclass="arabic simple">
<li><p>Return False if the given network will cause conflict.</p></li>
</ol>
</li>
<li><olclass="arabic simple"start="2">
<li><p>Always return True if network mode is set to DHCP.</p></li>
</ol>
</li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkRequest"title="com.vmware.vcenter.lcm_client.Validation.TemporaryNetworkRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.TemporaryNetworkRequest</span></code></a>) – The configuration needed to validate network.</p>
<codeclass="descname">check_upgrade_source_appliance_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Validation.check_upgrade_source_appliance_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the source appliance to be upgraded.</p>
<olclass="arabic simple">
<li><p>1. Return False if the provided source appliance credentials are
incorrect</p></li>
<li><p>2. Return False if the provided source location credentials are
incorrect.</p></li>
<li><olclass="arabic simple"start="3">
<li><p>Return False if upgrade runner precheck results in error.</p></li>
</ol>
</li>
<li><olclass="arabic simple"start="4">
<li><p>Return False if export directory provided is invalid.</p></li>
</ol>
</li>
</ol>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceRequest"title="com.vmware.vcenter.lcm_client.Validation.UpgradeSourceApplianceRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Validation.UpgradeSourceApplianceRequest</span></code></a>) – The configuration of the source appliance to be upgraded.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.lcm_client.</code><codeclass="descname">Vc</code><spanclass="sig-paren">(</span><em>connection=None</em>, <em>inventory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Vc"title="Permalink to this definition">¶</a></dt>
<p>Configuration of the VC that hosts/will host an appliance.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Connection"title="com.vmware.vcenter.lcm_client.Connection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Connection</span></code></a>) – The configuration to connect to an ESX/VC.</p></li>
<li><p><strong>inventory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.VcInventory"title="com.vmware.vcenter.lcm_client.VcInventory"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VcInventory</span></code></a>) – 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’. You must
always provide the ‘network_name’ key. To install a new appliance
to a specific ESX host in a cluster, provide the ‘host_path’ key,
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_folder_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Path of the VM folder. VM folder must be visible by the Data Center
of the compute resourceFormat:{vm_folder1}/{vm_folder2}e.g.:’VM
Folder 0/VM Folder1’.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>resource_pool_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to resource pool. Format: /{datacenter
folder}/{datacenter name}/host/{host
name}/{cluster_name}/Resources/{resource pool}. e.g: Your
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#resource_pool_path</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">#cluster_path</span></code>, and <codeclass="docutils literal notranslate"><spanclass="pre">#host_path</span></code></p></li>
<li><p><strong>cluster_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full path to the cluster. Format: /{datacenter folder}/{datacenter
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore on which to store the files of the appliance. This
value has to be either a specific datastore name, or a specific
datastore in a datastore cluster. The datastore must be accessible
from the ESX host and must have at least 25 GB of free space.
Otherwise, the new appliance might not power on.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<li><p><strong>datastore_cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The datastore cluster on which to store the files of the appliance.
Mutually exclusive between <codeclass="docutils literal notranslate"><spanclass="pre">#datastore_name</span></code> and
<li><p><strong>network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the network. e.g. VM Network</p></li>
<spanid="com-vmware-vcenter-ovf-client-module"></span><h2>com.vmware.vcenter.ovf_client module<aclass="headerlink"href="#module-com.vmware.vcenter.ovf_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.ovf_client</span></code> module provides services to capture and
deploy Open Virtualization Format (OVF) packages to and from the content
library.</p>
<p>It provides the ability to deploy OVF packages from the content library with
support for advanced network topologies, network services, creating virtual
appliances and virtual machines in hosts, resource pools or clusters. It also
provides the ability to export virtual appliances and virtual machines from
hosts, resource pools or clusters as OVF packages to the content library.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">CertificateParams</code><spanclass="sig-paren">(</span><em>issuer=None</em>, <em>subject=None</em>, <em>is_valid=None</em>, <em>is_self_signed=None</em>, <em>x509=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.CertificateParams"title="Permalink to this definition">¶</a></dt>
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>is_valid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the certificate chain validated.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>is_self_signed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the certificate self-signed.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>x509</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The X509 representation of the certificate.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">DeploymentOption</code><spanclass="sig-paren">(</span><em>key=None</em>, <em>label=None</em>, <em>description=None</em>, <em>default_choice=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DeploymentOption"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The key of the deployment option, corresponding to the ovf:id
attribute in the OVF descriptor.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A localizable label for the deployment option.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A localizable description for the deployment option.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>default_choice</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – A <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> flag indicates whether this deployment option is
the default choice.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None or false, it
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">DeploymentOptionParams</code><spanclass="sig-paren">(</span><em>deployment_options=None</em>, <em>selected_key=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>deployment_options</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DeploymentOption"title="com.vmware.vcenter.ovf_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of deployment options. This attribute corresponds to
the ovf:Configuration elements of the ovf:DeploymentOptionSection
in the specification. It is a discrete set of intended resource
allocation configurations from which one can be selected.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>selected_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The selected deployment option. Identifies the
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DeploymentOption"title="com.vmware.vcenter.ovf_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a> in the list in the <codeclass="docutils literal notranslate"><spanclass="pre">deploymentOptions</span></code>
attribute with a matching value in the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DeploymentOption.key</span></code>
attribute.
This attribute is optional in the input parameters when deploying
an OVF package. If None the server will use the default deployment
This attribute is optional in the result when retrieving
information about an OVF package. The value will be set only if it
is specified with the optional ovf:default attribute.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">DiskProvisioningType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code> class defines the virtual disk provisioning
types that can be set for a disk on the target platform.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> instance.</p>
<codeclass="descname">eagerZeroedThick</code><emclass="property"> = DiskProvisioningType(string='eagerZeroedThick')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick"title="Permalink to this definition">¶</a></dt>
<dd><p>An eager zeroed thick provisioned virtual disk has all space allocated and
wiped clean of any previous contents on the physical media at creation
time.</p>
<p>Disks specified as eager zeroed thick may take longer time to create than
disks specified with the other disk provisioning types.</p>
<codeclass="descname">thick</code><emclass="property"> = DiskProvisioningType(string='thick')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thick"title="Permalink to this definition">¶</a></dt>
<dd><p>A thick provisioned virtual disk has all space allocated at creation time
and the space is zeroed on demand as the space is used.</p>
<codeclass="descname">thin</code><emclass="property"> = DiskProvisioningType(string='thin')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thin"title="Permalink to this definition">¶</a></dt>
<dd><p>A thin provisioned virtual disk has space allocated and zeroed on demand as
the space is used.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.ExportFlag">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ExportFlag</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExportFlag"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExportFlag</span></code> class provides methods for retrieving information about
the export flags supported by the server. Export flags can be specified in
a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a> to customize an OVF export.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>option=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExportFlag.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExportFlag.Info</span></code> class describes an export flag supported by the
server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the export flag that is supported by the server.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the export flag.</p></li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExportFlag.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the supported export flags by the server.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>PRESERVE_MAC</dt><dd><p>Include MAC addresses for network adapters.</p>
</dd>
<dt>EXTRA_CONFIG</dt><dd><blockquote>
<div><p>Include extra configuration in OVF export.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ExtraConfig</code><spanclass="sig-paren">(</span><em>key=None</em>, <em>value=None</em>, <em>virtual_system_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExtraConfig"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The key of the ExtraConfig element.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of the ExtraConfig element.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>virtual_system_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual system containing the vmw:ExtraConfig
element.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ExtraConfigParams</code><spanclass="sig-paren">(</span><em>extra_configs=None</em>, <em>exclude_keys=None</em>, <em>include_keys=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExtraConfigParams"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExtraConfigParams</span></code> class contains the parameters with information
about the vmw:ExtraConfig elements in an OVF package.</p>
<p>vmw:ExtraConfig elements can be used to specify configuration settings that
are transferred directly to the <codeclass="docutils literal notranslate"><spanclass="pre">.vmx</span></code> file.</p>
<p>The behavior of the vmw:ExtraConfig element is similar to the
<codeclass="docutils literal notranslate"><spanclass="pre">extraConfig</span></code> property of the <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineConfigSpec</span></code> object in the
VMware vSphere API. Thus, the same restrictions apply, such as you cannot
set values that could otherwise be set with other properties in the
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineConfigSpec</span></code> object. See the VMware vSphere API reference
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>extra_configs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ExtraConfig"title="com.vmware.vcenter.ovf_client.ExtraConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExtraConfig</span></code></a>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of vmw:ExtraConfig elements in the OVF package.
This attribute is optional in the input parameters when deploying
an OVF package. If None there are no extra configuration elements
to use for this OVF package deployment. This attribute will always
be present in the result when retrieving information about an OVF
package. It will be an empty <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> if there are no extra
configuration elements in the OVF package.</p></li>
<li><p><strong>exclude_keys</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Specifies which extra configuration items in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> in
the <codeclass="docutils literal notranslate"><spanclass="pre">extraConfigs</span></code><codeclass="docutils literal notranslate"><spanclass="pre">field</span></code> should be ignored during deployment.</p>
<p>If set, the given keys for extra configurations will be ignored
<li><p><strong>include_keys</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Specifies which extra configuration items in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> in
the <codeclass="docutils literal notranslate"><spanclass="pre">extraConfigs</span></code><codeclass="docutils literal notranslate"><spanclass="pre">field</span></code> should be included during
deployment.</p>
<p>If set, all but the given keys for extra configurations will be
ignored during deployment. The key is defined in the
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.ImportFlag">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ImportFlag</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ImportFlag"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportFlag</span></code> class provides methods for retrieving information about
the import flags supported by the deployment platform. Import flags can be
specified in a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to customize
an OVF deployment.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>option=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ImportFlag.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportFlag.Info</span></code> class describes an import flag supported by the
deployment platform.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the import flag that is supported by the deployment
platform.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the import flag.</p></li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>rp</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ImportFlag.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the import flags supported by the deployment
platform.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>LAX</dt><dd><blockquote>
<div><p>Lax mode parsing of the OVF descriptor.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
</dd>
</dl>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>rp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of resource pool target for retrieving the import
flag(s).
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">IpAllocationParams</code><spanclass="sig-paren">(</span><em>supported_allocation_scheme=None</em>, <em>supported_ip_allocation_policy=None</em>, <em>ip_allocation_policy=None</em>, <em>supported_ip_protocol=None</em>, <em>ip_protocol=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>supported_allocation_scheme</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationScheme</span></code></a>) – Specifies the IP allocation schemes supported by the guest
software. This attribute defines the valid values for the IP
allocation policy. This setting is often configured by the virtual
appliance template author or OVF package author to reflect what the
guest software supports, and the IP allocation policy is configured
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>supported_ip_allocation_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) – Specifies the IP allocation policies supported. The set of valid
options for the policy is based on the capabilities of the virtual
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>ip_allocation_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) – Specifies how IP allocation is done through an IP Pool. This is
typically specified by the deployer.
This attribute is optional in the input parameters when deploying
an OVF package. If None there is no IP allocation policy. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>supported_ip_protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code></a>) – Specifies the IP protocols supported by the guest.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>ip_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code></a>) – Specifies the chosen IP protocol for this deployment. This must be
one of the IP protocols supported by the guest software. See
This attribute is optional in the input parameters when deploying
an OVF package. If None there is no IP protocol chosen. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descname">IpAllocationPolicy</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code> class defines the possible IP
allocation policy for a deployment.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationPolicy</span></code> instance.</p>
<codeclass="descname">DHCP</code><emclass="property"> = IpAllocationPolicy(string='DHCP')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that DHCP will be used to allocate IP addresses.</p>
<codeclass="descname">STATIC_IPPOOL</code><emclass="property"> = IpAllocationPolicy(string='STATIC_IPPOOL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are allocated from the range managed by an IP
pool. The IP addresses are allocated at first power-on, and remain
allocated at power-off. This ensures that a virtual appliance gets a
<codeclass="descname">STATIC_MANUAL</code><emclass="property"> = IpAllocationPolicy(string='STATIC_MANUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are configured manually upon deployment, and
will be kept until reconfigured or the virtual appliance destroyed. This
ensures that a property gets a consistent IP for its lifetime.</p>
<codeclass="descname">TRANSIENT_IPPOOL</code><emclass="property"> = IpAllocationPolicy(string='TRANSIENT_IPPOOL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are allocated from an IP pool. The IP addresses
are allocated when needed, typically at power-on, and deallocated during
power-off. There is no guarantee that a property will receive same IP
<emclass="property">class </em><codeclass="descname">IpAllocationScheme</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationScheme</span></code> class defines the possible IP
allocation schemes that can be supported by the guest software.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationScheme</span></code> instance.</p>
<codeclass="descname">DHCP</code><emclass="property"> = IpAllocationScheme(string='DHCP')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>It supports DHCP to acquire IP configuration.</p>
<codeclass="descname">OVF_ENVIRONMENT</code><emclass="property"> = IpAllocationScheme(string='OVF_ENVIRONMENT')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT"title="Permalink to this definition">¶</a></dt>
<dd><p>It supports setting the IP configuration through the properties provided in
<emclass="property">class </em><codeclass="descname">IpProtocol</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code> class defines the IP protocols
supported by the guest software.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpProtocol</span></code> instance.</p>
<codeclass="descname">IPV4</code><emclass="property"> = IpProtocol(string='IPV4')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">IPV6</code><emclass="property"> = IpProtocol(string='IPV6')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">LibraryItem</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem</span></code> class provides methods to deploy virtual machines and
virtual appliances from library items containing Open Virtualization Format
(OVF) packages in content library, as well as methods to create library
items in content library from virtual machines and virtual appliances.</p>
<blockquote>
<div><p>To deploy a virtual machine or a virtual appliance from a library item:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code></a> to specify the target
deployment type and target deployment designation.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to specify the
parameters for the target deployment.</p></li>
<li><p>Use the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method with the created target and parameter
specifications, along with the identifier of the specified source content
library item. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>.</p></li>
</ol>
<p>To create a library item in content library from a virtual machine or
virtual appliance:</p>
<olclass="arabic simple">
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a> to specify the source
virtual machine or virtual appliance to be used as the OVF template source.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateTarget</span></code></a> to specify the target library
and library item.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a> to specify the settings for the
OVF package to be created.</p></li>
<li><p>Use the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method with the created target and parameter
specifications, along with the specified source entity. See
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">CreateResult</code><spanclass="sig-paren">(</span><em>succeeded=None</em>, <em>ovf_library_item_id=None</em>, <em>error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.CreateResult</span></code> class defines the result of the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code>
method. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.create"title="com.vmware.vcenter.ovf_client.LibraryItem.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.create()</span></code></a>.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
<li><p><strong>ovf_library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the created or updated library item.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
If None, the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method failed and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.CreateResult.error</span></code> will describe the error(s)
that caused the failure.</p></li>
<li><p><strong>error</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>flags=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code> class defines the information used to create
or update a library item containing an OVF package.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name to use in the OVF descriptor stored in the library item.
If None, the server will use source’s current name.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description to use in the OVF descriptor stored in the library
item.
If None, the server will use source’s current annotation.</p></li>
<li><p><strong>flags</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flags to use for OVF package creation. The supported flags can be
obtained using <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ExportFlag.list"title="com.vmware.vcenter.ovf_client.ExportFlag.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ExportFlag.list()</span></code></a>.
<emclass="property">class </em><codeclass="descname">CreateTarget</code><spanclass="sig-paren">(</span><em>library_id=None</em>, <em>library_item_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the library in which a new library item should be
created. This attribute is not used if the <codeclass="docutils literal notranslate"><spanclass="pre">libraryItemId</span></code>
attribute is specified.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
If None, the <codeclass="docutils literal notranslate"><spanclass="pre">libraryItemId</span></code> attribute must be specified.</p></li>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the library item that should be should be updated.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
If None, a new library item will be created. The <codeclass="docutils literal notranslate"><spanclass="pre">libraryId</span></code>
attribute must be specified if this attribute is None.</p></li>
<codeclass="descname">DEPLOYABLE</code><emclass="property"> = ['VirtualMachine', 'VirtualApp']</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The types of resources that can be created by deploying an OVF package and can
be captured to create a library item using the <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem</span></code> class.</p>
<emclass="property">class </em><codeclass="descname">DeployableIdentity</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code> class describes the resource created
by a deployment, or the source resource from which library item can be
created, by specifying its resource type and resource identifier.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the deployable resource.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">VirtualApp</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">VirtualApp</span></code>.</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the deployable resource.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for one of these resource types:
<codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for one of
these resource types: <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code>.</p></li>
<emclass="property">class </em><codeclass="descname">DeploymentResult</code><spanclass="sig-paren">(</span><em>succeeded=None</em>, <em>resource_id=None</em>, <em>error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_id</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the deployed resource entity.
If None, the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method failed and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentResult.error</span></code> will describe the
error(s) that caused the failure.</p></li>
<li><p><strong>error</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
<emclass="property">class </em><codeclass="descname">DeploymentTarget</code><spanclass="sig-paren">(</span><em>resource_pool_id=None</em>, <em>host_id=None</em>, <em>folder_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code> class describes the location (target)
where a virtual machine or virtual appliance should be deployed. It is used
in the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">filter</span></code> methods. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>
and <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>resource_pool_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the resource pool to which the virtual machine or
virtual appliance should be attached.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>host_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target host on which the virtual machine or
virtual appliance will run. The target host must be a member of the
cluster that contains the resource pool identified by
If None, the server will automatically select a target host from
the resource pool if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> is a
stand-alone host or a cluster with Distributed Resource Scheduling
(DRS) enabled.</p></li>
<li><p><strong>folder_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the vCenter folder that should contain the virtual
machine or virtual appliance. The folder must be virtual machine
folder.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
If None, the server will choose the deployment folder.</p></li>
<emclass="property">class </em><codeclass="descname">OvfSummary</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>annotation=None</em>, <em>eulas=None</em>, <em>networks=None</em>, <em>storage_groups=None</em>, <em>additional_params=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.OvfSummary</span></code> class defines the result of the <codeclass="docutils literal notranslate"><spanclass="pre">filter</span></code>
method. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>. The attributes in the class
describe parameterizable information in the OVF descriptor, with respect to
a deployment target, for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. See
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default name for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify a name.</p></li>
<li><p><strong>annotation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default annotation for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify an annotation.</p></li>
<li><p><strong>eulas</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – End User License Agreements specified in the OVF descriptor. All
end user license agreements must be accepted in order for the
<codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method to succeed. See
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Section identifiers for sections of type ovf:NetworkSection in the
OVF descriptor. These identifiers can be used as keys in
If None, the OVF descriptor did not specify any networks.</p></li>
<li><p><strong>storage_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Section identifiers for sections of type vmw:StorageGroupSection in
the OVF descriptor. These identifiers can be used as keys in
If None, the OVF descriptor did not specify any storage groups.</p></li>
<li><p><strong>additional_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional OVF parameters which can be specified for the deployment
target. These OVF parameters can be inspected, optionally modified,
for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>.
If None, the OVF descriptor does not require addtional parameters
or does not have additional parameters suitable for the deployment
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code> class defines the deployment
parameters that can be specified for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method where the
deployment target is a resource pool. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name assigned to the deployed target virtual machine or virtual
appliance.
If None, the server will use the name from the OVF package.</p></li>
<li><p><strong>annotation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Annotation assigned to the deployed target virtual machine or
virtual appliance.
If None, the server will use the annotation from the OVF package.</p></li>
<li><p><strong>accept_all_eula</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to accept all End User License Agreements. See
<li><p><strong>network_mappings</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of the target network to use for sections of type
ovf:NetworkSection in the OVF descriptor. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the section identifier of the ovf:NetworkSection
section in the OVF descriptor and the value is the target network
to be used for deployment.
When clients pass a value of this class as a parameter, the value
in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the
resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>. When methods return a value of this
class as a return value, the value in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>
will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
If None, the server will choose a network mapping.</p></li>
<li><p><strong>storage_mappings</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of the target storage to use for sections of type
vmw:StorageGroupSection in the OVF descriptor. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the section identifier of the
ovf:StorageGroupSection section in the OVF descriptor and the value
is the target storage specification to be used for deployment. See
If None, the server will choose a storage mapping.</p></li>
<li><p><strong>storage_provisioning</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default storage provisioning type to use for all sections of type
vmw:StorageSection in the OVF descriptor.
If None, the server will choose the provisioning type.</p></li>
<li><p><strong>storage_profile_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default storage profile to use for all sections of type
vmw:StorageSection in the OVF descriptor.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the server will choose the default profile.</p></li>
<li><p><strong>locale</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The locale to use for parsing the OVF descriptor.
If None, the server locale will be used.</p></li>
<li><p><strong>flags</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flags to be use for deployment. The supported flag values can be
obtained using <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ImportFlag.list"title="com.vmware.vcenter.ovf_client.ImportFlag.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ImportFlag.list()</span></code></a>.
If None, no flags will be used.</p></li>
<li><p><strong>additional_parameters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Additional OVF parameters that may be needed for the deployment.
Additional OVF parameters may be required by the OVF descriptor of
the OVF package in the library item. Examples of OVF parameters
that can be specified through this attribute include, but are not
<p>When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>.
If None, the server will choose default settings for all parameters
necessary for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. See
<li><p><strong>default_datastore_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default datastore to use for all sections of type
vmw:StorageSection in the OVF descriptor.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property">class </em><codeclass="descname">ResultInfo</code><spanclass="sig-paren">(</span><em>errors=None</em>, <em>warnings=None</em>, <em>information=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code> class defines the information returned along
with the result of a <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method to describe errors,
warnings, and informational messages produced by the server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfError"title="com.vmware.vcenter.ovf_client.OvfError"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfError</span></code></a>) – Errors reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. These
errors would have prevented the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method
from completing successfully.</p></li>
<li><p><strong>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfWarning"title="com.vmware.vcenter.ovf_client.OvfWarning"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfWarning</span></code></a>) – Warnings reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. These
warnings would not have prevented the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code>
method from completing successfully, but there might be issues that
warrant attention.</p></li>
<li><p><strong>information</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfInfo"title="com.vmware.vcenter.ovf_client.OvfInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfInfo</span></code></a>) – Information messages reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code>
method. For example, a non-required parameter was ignored.</p></li>
<emclass="property">class </em><codeclass="descname">StorageGroupMapping</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>datastore_id=None</em>, <em>storage_profile_id=None</em>, <em>provisioning=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping</span></code> class defines the storage
deployment target and storage provisioning type for a section of type
vmw:StorageGroupSection in the OVF descriptor.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type</span></code></a>) – Type of storage deployment target to use for the
vmw:StorageGroupSection section. The specified value must be
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a> or
<li><p><strong>datastore_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Target datastore to be used for the storage group.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>storage_profile_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Target storage profile to be used for the storage group.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>provisioning</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Target provisioning type to use for the storage group.
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type</span></code> class defines the supported
types of storage targets for sections of type vmw:StorageGroupSection in
the OVF descriptor.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code> instance.</p>
<codeclass="descname">DATASTORE</code><emclass="property"> = Type(string='DATASTORE')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"title="Permalink to this definition">¶</a></dt>
<dd><p>Storage deployment target is a datastore.</p>
<codeclass="descname">STORAGE_PROFILE</code><emclass="property"> = Type(string='STORAGE_PROFILE')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Storage deployment target is a storage profile.</p>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>source</em>, <em>target</em>, <em>create_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a library item in content library from a virtual machine or
virtual appliance.</p>
<p>This method creates a library item in content library whose content is
an OVF package derived from a source virtual machine or virtual
appliance, using the supplied create specification. The OVF package may
be stored as in a newly created library item or in an in an existing
library item. For an existing library item whose content is updated by
this method, the original content is overwritten.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client-generated token used to retry a request if the client fails
to get a response from the server. If the original request
succeeded, the result of that request will be returned, otherwise
the operation will be retried.
If None, the server will create a token.</p></li>
<li><p><strong>source</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a>) – Identifier of the virtual machine or virtual appliance to use as
the source.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateTarget</span></code></a>) – Specification of the target content library and library item.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a>) – Information used to create the OVF package from the source virtual
<li><p>The resource <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> referenced by the attribute
<codeclass="descname">deploy</code><spanclass="sig-paren">(</span><em>ovf_library_item_id</em>, <em>target</em>, <em>deployment_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys an OVF package stored in content library to a newly created
virtual machine or virtual appliance.</p>
<p>This method deploys an OVF package which is stored in the library item
specified by <codeclass="docutils literal notranslate"><spanclass="pre">ovf_library_item_id</span></code>. It uses the deployment
specification in <codeclass="docutils literal notranslate"><spanclass="pre">deployment_spec</span></code> to deploy the OVF package to the
location specified by <codeclass="docutils literal notranslate"><spanclass="pre">target</span></code>.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client-generated token used to retry a request if the client fails
to get a response from the server. If the original request
succeeded, the result of that request will be returned, otherwise
the operation will be retried.
If None, the server will create a token.</p></li>
<li><p><strong>ovf_library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the content library item containing the OVF package
to be deployed.
The parameter must be an identifier for the resource type:
<li><p><strong>target</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code></a>) – Specification of the deployment target.</p></li>
<li><p><strong>deployment_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>) – Specification of how the OVF package should be deployed to the
if there was an error accessing the OVF package stored in the
library item specified by <codeclass="docutils literal notranslate"><spanclass="pre">ovf_library_item_id</span></code>.</p>
</dd>
<dtclass="field-odd">Raise</dt>
<ddclass="field-odd"><dlclass="simple">
<dt><aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized"title="com.vmware.vapi.std.errors_client.Unauthorized"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a></dt><dd><p>if you do not have all of the privileges described as follows :</p>
</dd>
</dl>
<ulclass="simple">
<li><p>Method execution requires VirtualMachine.Config.AddNewDisk if the
OVF descriptor has a disk drive (type 17) section.</p></li>
<li><p>Method execution requires VirtualMachine.Config.AdvancedConfig if
the OVF descriptor has an ExtraConfig section.</p></li>
<li><p>Method execution requires Extension.Register for specified
resource group if the OVF descriptor has a vServiceDependency
section.</p></li>
<li><p>Method execution requires Network.Assign for target network if
specified.</p></li>
<li><p>Method execution requires Datastore.AllocateSpace for target
<li><p>The resource <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code> referenced by the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> value of
<codeclass="descname">filter</code><spanclass="sig-paren">(</span><em>ovf_library_item_id</em>, <em>target</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="Permalink to this definition">¶</a></dt>
<dd><p>Queries an OVF package stored in content library to retrieve
information to use when deploying the package. See
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">OvfError</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfError"title="Permalink to this definition">¶</a></dt>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.OvfInfo">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">OvfInfo</code><spanclass="sig-paren">(</span><em>messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfInfo"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">OvfMessage</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage"title="Permalink to this definition">¶</a></dt>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category"title="Permalink to this definition">¶</a></dt>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Category</span></code> instance.</p>
<codeclass="descname">INPUT</code><emclass="property"> = Category(string='INPUT')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="Permalink to this definition">¶</a></dt>
<dd><p>The user provided input parameters are invalid.</p>
<codeclass="descname">SERVER</code><emclass="property"> = Category(string='SERVER')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VALIDATION</code><emclass="property"> = Category(string='VALIDATION')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="Permalink to this definition">¶</a></dt>
<dd><p>The OVF descriptor is invalid, for example, syntax errors or schema errors.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.OvfParams">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">OvfParams</code><spanclass="sig-paren">(</span><em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.OvfWarning">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">OvfWarning</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfWarning"title="Permalink to this definition">¶</a></dt>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.ParseIssue">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ParseIssue</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>file=None</em>, <em>line_number=None</em>, <em>column_number=None</em>, <em>message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ParseIssue</span></code> class contains the information about the issue found
when parsing an OVF package during deployment or exporting an OVF package
including:</p>
<ulclass="simple">
<li><p>Parsing and validation error on OVF descriptor (which is an XML
document), manifest and certificate files.</p></li>
<li><p>OVF descriptor generating and device error.</p></li>
<li><p>Unexpected server error.</p></li>
</ul>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category"title="com.vmware.vcenter.ovf_client.ParseIssue.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ParseIssue.Category</span></code></a>) – The category of the parse issue.</p></li>
<li><p><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file in which the parse issue was found.</p></li>
<li><p><strong>line_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The line number of the line in the file (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ParseIssue.file</span></code>) where the parse issue was found (or -1 if
not applicable).</p></li>
<li><p><strong>column_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The position in the line (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ParseIssue.line_number</span></code>) (or
-1 if not applicable).</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message describing the parse issue.</p></li>
<emclass="property">class </em><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ParseIssue.Category</span></code> class defines the categories of issues that can
be found when parsing files inside an OVF package (see <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ParseIssue"title="com.vmware.vcenter.ovf_client.ParseIssue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ParseIssue</span></code></a>)
including OVF descriptor (which is an XML document), manifest and
certificate files, or exporting an OVF package.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Category</span></code> instance.</p>
<codeclass="descname">ATTRIBUTE_ILLEGAL</code><emclass="property"> = Category(string='ATTRIBUTE_ILLEGAL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal attribute error. It indicates that an illegal attribute is set for
an element in the OVF descriptor. For example, empty disks do not use
format, parentRef, and populatedSize attributes, if these attributes are
present in an empty disk element then will get this pasrse issue.</p>
<codeclass="descname">ATTRIBUTE_REQUIRED</code><emclass="property"> = Category(string='ATTRIBUTE_REQUIRED')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Required attribute error. It indicates that a required attribute is missing
<codeclass="descname">ELEMENT_ILLEGAL</code><emclass="property"> = Category(string='ELEMENT_ILLEGAL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal element error. It indicates that an element is present in a
location which is not allowed, or found multiple elements but only one is
allowed at the location in the OVF descriptor.</p>
<codeclass="descname">ELEMENT_REQUIRED</code><emclass="property"> = Category(string='ELEMENT_REQUIRED')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Required element error. It indicates that a required element is missing
<codeclass="descname">ELEMENT_UNKNOWN</code><emclass="property"> = Category(string='ELEMENT_UNKNOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Unknown element error. It indicates that an element is unsupported when
<codeclass="descname">EXPORT_ERROR</code><emclass="property"> = Category(string='EXPORT_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Issue during OVF export, for example, malformed deviceId, controller not
found, or file backing for a device not found.</p>
<codeclass="descname">GENERATE_ERROR</code><emclass="property"> = Category(string='GENERATE_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>OVF descriptor (which is an XML document) generating error, for example,
well-formedness errors as well as unexpected processing conditions.</p>
<codeclass="descname">INTERNAL_ERROR</code><emclass="property"> = Category(string='INTERNAL_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Server encountered an unexpected error which prevented it from fulfilling
<codeclass="descname">PARSE_ERROR</code><emclass="property"> = Category(string='PARSE_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>OVF package parsing error, including:</p>
<ulclass="simple">
<li><p>OVF descriptor parsing errors, for example, syntax errors or schema
errors.</p></li>
<li><p>Manifest file parsing and verification errors.</p></li>
<li><p>Certificate file parsing and verification errors.</p></li>
<codeclass="descname">SECTION_RESTRICTION</code><emclass="property"> = Category(string='SECTION_RESTRICTION')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION"title="Permalink to this definition">¶</a></dt>
<dd><p>Section restriction error. It indicates that a section appears in place in
the OVF descriptor where it is not allowed, a section appears fewer times
than is required, or a section appears more times than is allowed.</p>
<codeclass="descname">SECTION_UNKNOWN</code><emclass="property"> = Category(string='SECTION_UNKNOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Section unknown error. It indicates that a section is unsupported when
<codeclass="descname">VALIDATION_ERROR</code><emclass="property"> = Category(string='VALIDATION_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>An issue with the manifest and signing.</p>
<codeclass="descname">VALUE_ILLEGAL</code><emclass="property"> = Category(string='VALUE_ILLEGAL')</em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal value error. For example, the value is malformed, not a number, or
outside of the given range, and so on.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.Property">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">Property</code><spanclass="sig-paren">(</span><em>class_id=None</em>, <em>id=None</em>, <em>instance_id=None</em>, <em>category=None</em>, <em>ui_optional=None</em>, <em>label=None</em>, <em>description=None</em>, <em>type=None</em>, <em>value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.Property"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Property</span></code> class contains the information about a property in an OVF
package.</p>
<p>A property is uniquely identified by its [classid.]id[.instanceid]
fully-qualified name (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.class_id</span></code>, <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.id</span></code>,
and <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.instance_id</span></code>). If multiple properties in an OVF package
have the same fully-qualified name, then the property is excluded and
cannot be set. We do warn about this during import.</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>class_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The classId of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of this OVF property.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>instance_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The instanceId of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>category</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – If this is set to a non-empty string, this property starts a new
category.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None, the property
is in the same category as the previous item, otherwise, it starts
a new category.</p></li>
<li><p><strong>ui_optional</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether a category is UI optional. This is only used if this
property starts a new category (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.category</span></code>).</p>
<p>The value is stored in an optional attribute vmw:uioptional to the
ovf:Category element. The default value is false. If this value is
true, the properties within this category are optional. The UI
renders this as a group with a check box, and the group is grayed
out until the check box is selected. When the check box is
selected, the input values are read and used in deployment. If
properties within the same category specify conflicting values the
default is used. Only implemented in vSphere Web Client 5.1 and
later as of Nov 2012.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package.</p>
</p></li>
<li><p><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A description of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The type of this OVF property. Refer to the configuration of a
virtual appliance/virtual machine for the valid values.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The OVF property value. This contains the default value from
ovf:defaultValue if ovf:value is not present when read.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">PropertyParams</code><spanclass="sig-paren">(</span><em>properties=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.PropertyParams"title="Permalink to this definition">¶</a></dt>
This attribute is optional in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ScaleOutGroup</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>description=None</em>, <em>instance_count=None</em>, <em>minimum_instance_count=None</em>, <em>maximum_instance_count=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ScaleOutGroup"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the scale-out group.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the scale-out group.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>instance_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The scaling factor to use. It defines the number of replicas of the
prototypical virtual system or virtual system collection.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">ScaleOutParams</code><spanclass="sig-paren">(</span><em>groups=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ScaleOutParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ScaleOutGroup"title="com.vmware.vcenter.ovf_client.ScaleOutGroup"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ScaleOutGroup</span></code></a>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of scale-out groups.
This attribute is optional in the input parameters when deploying
an OVF package. If None there are no scale-out groups. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter.ovf_client.SizeParams">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">SizeParams</code><spanclass="sig-paren">(</span><em>approximate_download_size=None</em>, <em>approximate_flat_deployment_size=None</em>, <em>approximate_sparse_deployment_size=None</em>, <em>variable_disk_size=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.SizeParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>approximate_download_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) –<p>A best guess as to the total amount of data that must be
transferred to download the OVF package.</p>
<blockquote>
<div><p>This may be inaccurate due to disk compression etc.</p>
</div></blockquote>
<p>This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p>
</p></li>
<li><p><strong>approximate_flat_deployment_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – A best guess as to the total amount of space required to deploy the
OVF package if using flat disks.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p></li>
<li><p><strong>approximate_sparse_deployment_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – A best guess as to the total amount of space required to deploy the
OVF package using sparse disks.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p></li>
<li><p><strong>variable_disk_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether the OVF uses variable disk sizes.</p>
<p>For empty disks, rather than specifying a fixed virtual disk
capacity, the capacity may be given using a reference to a
ovf:Property element in a ovf:ProductSection element in OVF
package.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None or false, the
OVF does not use variable disk sizes.</p>
</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">UnknownSection</code><spanclass="sig-paren">(</span><em>tag=None</em>, <em>info=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.UnknownSection"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">UnknownSection</span></code> class contains information about an unknown section
in an OVF package.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A namespace-qualified tag in the form <codeclass="docutils literal notranslate"><spanclass="pre">{ns}tag</span></code>.</p></li>
<li><p><strong>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the Info element.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">UnknownSectionParams</code><spanclass="sig-paren">(</span><em>unknown_sections=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.UnknownSectionParams"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">UnknownSectionParams</span></code> class contains a <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of unknown,
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.ovf_client.</code><codeclass="descname">VcenterExtensionParams</code><spanclass="sig-paren">(</span><em>required=None</em>, <em>registration_accepted=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether registration as a vCenter extension is required.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>registration_accepted</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether registration as a vCenter extension is accepted.</p>
<p>If registration as a vCenter extension is required (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VcenterExtensionParams.required</span></code>), this must be set to true
during deployment. Defaults to false when returned from server.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p>
</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<spanid="com-vmware-vcenter-services-client-module"></span><h2>com.vmware.vcenter.services_client module<aclass="headerlink"href="#module-com.vmware.vcenter.services_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.services_client.</code><codeclass="descname">Service</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service</span></code> class provides methods to manage a single/set of vCenter
Server services. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Health</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.Health</span></code> class defines the possible values for health of a
service. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Health</span></code> instance.</p>
<codeclass="descname">DEGRADED</code><emclass="property"> = Health(string='DEGRADED')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.DEGRADED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in degraded state, it is not functional. This class attribute
<codeclass="descname">HEALTHY</code><emclass="property"> = Health(string='HEALTHY')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in a healthy state and is fully functional. This class attribute
<codeclass="descname">HEALTHY_WITH_WARNINGS</code><emclass="property"> = Health(string='HEALTHY_WITH_WARNINGS')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY_WITH_WARNINGS"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is healthy with warnings. This class attribute was added in vSphere
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name_key=None</em>, <em>description_key=None</em>, <em>startup_type=None</em>, <em>state=None</em>, <em>health=None</em>, <em>health_messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.Info</span></code> class contains information about a service. This class
was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service name key. Can be used to lookup resource bundle. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>description_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service description key. Can be used to lookup resource bundle.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>startup_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType"title="com.vmware.vcenter.services_client.Service.StartupType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code></a>) – Startup Type. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State"title="com.vmware.vcenter.services_client.Service.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.State</span></code></a>) – Running State. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.Health"title="com.vmware.vcenter.services_client.Service.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.Health</span></code></a>) – Health of service. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="com.vmware.vcenter.services_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</p></li>
<li><p><strong>health_messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable messages associated with the health of the service.
This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="com.vmware.vcenter.services_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descname">StartupType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code> class defines valid Startup Type for vCenter
Server services. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StartupType</span></code> instance.</p>
<codeclass="descname">AUTOMATIC</code><emclass="property"> = StartupType(string='AUTOMATIC')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.AUTOMATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Automatic, thus during starting all services or
issuing explicit start on the service will start it. This class attribute
<codeclass="descname">DISABLED</code><emclass="property"> = StartupType(string='DISABLED')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Disabled, thus it will not start unless the startup
type changes to manual or automatic. This class attribute was added in
<codeclass="descname">MANUAL</code><emclass="property"> = StartupType(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Manual, thus issuing an explicit start on the
service will start it. This class attribute was added in vSphere API 6.7.</p>
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.State</span></code> class defines valid Run State for services. This
enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="descname">STARTED</code><emclass="property"> = State(string='STARTED')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Started, it is fully functional. This class attribute
<codeclass="descname">STARTING</code><emclass="property"> = State(string='STARTING')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STARTING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Starting, it is still not functional. This class
<codeclass="descname">STOPPED</code><emclass="property"> = State(string='STOPPED')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STOPPED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
<codeclass="descname">STOPPING</code><emclass="property"> = State(string='STOPPING')</em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STOPPING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>startup_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.UpdateSpec</span></code> class describes the changes to be made to the
configuration of the service. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>startup_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType"title="com.vmware.vcenter.services_client.Service.StartupType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Startup Type. This attribute was added in vSphere API 6.7.
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the state of a service. This method was added in vSphere API
6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose state is being queried.
The parameter must be an identifier for the resource type:
<codeclass="descname">list_details</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.list_details"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists details of vCenter services. This method was added in vSphere API
<codeclass="descname">restart</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.restart"title="Permalink to this definition">¶</a></dt>
<dd><p>Restarts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to restart
The parameter must be an identifier for the resource type:
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to start
The parameter must be an identifier for the resource type:
<codeclass="descname">stop</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.stop"title="Permalink to this definition">¶</a></dt>
<dd><p>Stops a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to stop
The parameter must be an identifier for the resource type:
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>service</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the properties of a service. This method was added in vSphere
API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose properties are being updated.
The parameter must be an identifier for the resource type:
if a request to set the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.UpdateSpec.startup_type</span></code>
attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> to <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED"title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.StartupType.DISABLED</span></code></a> comes
in for a service that is not in <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STOPPED"title="com.vmware.vcenter.services_client.Service.State.STOPPED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STOPPED</span></code></a>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.services_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-storage-client-module"></span><h2>com.vmware.vcenter.storage_client module<aclass="headerlink"href="#module-com.vmware.vcenter.storage_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.storage_client.</code><codeclass="descname">Policies</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies</span></code> class provides methods for managing the storage policies.
This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">CompatibilityInfo</code><spanclass="sig-paren">(</span><em>compatible_datastores=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.CompatibilityInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.CompatibilityInfo</span></code> class contains info about a list of
datastores compatible with a specific storage policy. This class was added
in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>compatible_datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"title="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.CompatibleDatastoreInfo</span></code></a>) – Info about a list of datastores compatible with a specific storage
policy. This attribute was added in vSphere API 6.7.</p>
<emclass="property">class </em><codeclass="descname">CompatibleDatastoreInfo</code><spanclass="sig-paren">(</span><em>datastore=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.CompatibleDatastoreInfo</span></code> class contains compatible
datastore’s information. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore. This attribute was added in vSphere
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>policies=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code> class contains attributes used to filter the
results when listing the storage policies (see <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.list"title="com.vmware.vcenter.storage_client.Policies.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Policies.list()</span></code></a>). This
class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>policies</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of storage policies that can match the filter. This
attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will contain
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.StoragePolicy'</em><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for vAPI metadata policy. This class attribute was added in
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>policy=None</em>, <em>name=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.Summary</span></code> class contains commonly used information about a
storage policy. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy. This attribute was added in
vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the storage policy. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the storage policy. This attribute was added in
<codeclass="descname">check_compatibility</code><spanclass="sig-paren">(</span><em>policy</em>, <em>datastores</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.check_compatibility"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns datastore compatibility summary about a specific storage
policy. This method was added in vSphere API 6.7.</p>
<li><p><strong>datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Datastores used to check compatibility against a storage policy.
The number of datastores is limited to 1024.
The parameter must contain identifiers for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1024 visible (subject to permission
checks) storage solicies availabe in vCenter. These storage policies
can be used for provisioning virtual machines or disks. This method was
added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching storage policies for which information
should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> with all attributes None which means
if the <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> contains a value that is not
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.storage_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-system-config-client-module"></span><h2>com.vmware.vcenter.system_config_client module<aclass="headerlink"href="#module-com.vmware.vcenter.system_config_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.system_config_client.</code><codeclass="descname">DeploymentType</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType</span></code> class provides methods to get/set the type of the
appliance. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">ConvergenceSpec</code><spanclass="sig-paren">(</span><em>psc=None</em>, <em>replication_partner_hostname=None</em>, <em>only_precheck=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.ConvergenceSpec</span></code> class contains information used for
vCenter external to embedded PSC convergence operation. This class was
added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.system_config_client.DeploymentType.PscInfo"title="com.vmware.vcenter.system_config_client.DeploymentType.PscInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.PscInfo</span></code></a>) – The information about the Platform Service Controller. This
attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>replication_partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The (earlier converged) embedded node with which the Platform
Services Controller replication has to be set during convergence.
This attribute was added in vSphere API 6.7.2.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> then the converged embedded node will be set in
replication mode with this node.</p></li>
<li><p><strong>only_precheck</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to pass if only pre-check to be performed. This attribute was
added in vSphere API 6.7.2.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> will perform only pre-checks.</p></li>
<emclass="property">class </em><codeclass="descname">DomainInfo</code><spanclass="sig-paren">(</span><em>ad_domain_name=None</em>, <em>ad_domain_admin_username=None</em>, <em>ad_domain_admin_password=None</em>, <em>dns_server=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.DomainInfo</span></code> class contains information used to join
the converged node to the AD domain. This is used when participating PSC
node is already joined to AD. This class was added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ad_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Platform Services Controller node’s AD domain name if exits.
This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>ad_domain_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The AD domain username with privileges to join any machine to the
provided domain. This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>ad_domain_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – AD domain password with privileges to join any machine to the
provided domain. This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>dns_server</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of the DNS server of the Active Directory server. This
attribute was added in vSphere API 6.7.2.</p></li>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.Info</span></code> class contains the fields used to get the
appliance type. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) – The type of the appliance. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">PscInfo</code><spanclass="sig-paren">(</span><em>sso_admin_username=None</em>, <em>sso_admin_password=None</em>, <em>skip_ad_domain_join=None</em>, <em>ad_domain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.PscInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.PscInfo</span></code> class contains information about Platform
Services Controller node participating in reconfiguration. This class was
added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator username for example
“administrator\@vsphere.local”. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>skip_ad_domain_join</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A flag to skip domain join operation for embedded node during
convergence. If the Platform Services Controller node is joined to
an AD domain, the same is expected to be configured for converged
embedded node, but there can be situations (e.g. no domain admin
credentials with VI admin) during convergence when needs to be done
later via existing UI option. This attribute was added in vSphere
API 6.7.2.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> will skip AD domain join operations</p></li>
<li><p><strong>ad_domain</strong> (<aclass="reference internal"href="#com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo"title="com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.DomainInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the domain which Platform Services Controller
node is joined to. The reconfigured machine will be joined to the
same domain. This attribute was added in vSphere API 6.7.2.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> then converged embedded node will be joined to this
<emclass="property">class </em><codeclass="descname">ReconfigureSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>remote_psc=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.ReconfigureSpec</span></code> class contains the fields used to
get and set the appliance type. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) – The type of the appliance. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>remote_psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.RemotePscSpec"title="com.vmware.vcenter.deployment_client.RemotePscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – External PSC to register with when reconfiguring a VCSA_EMBEDDED
appliance to a VCSA_EXTERNAL appliance. This attribute was added in
vSphere API 6.7.
Only required when reconfiguring an VCSA_EMBEDDED node to a
<codeclass="descname">convert_to_vcsa_embedded_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.convert_to_vcsa_embedded_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the type of the vCenter appliance to vCSA embedded. This method
was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec"title="com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.ConvergenceSpec</span></code></a>) – ConvergenceSpec to provide all needed information for convergence
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the type of the vCenter appliance. This method was added in vSphere
<codeclass="descname">reconfigure</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.reconfigure"title="Permalink to this definition">¶</a></dt>
<dd><p>Reconfigure the type of the vCenter appliance. This method was added in
vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"title="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.ReconfigureSpec</span></code></a>) – ReconfigureSpec to set the appliance type.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.system_config_client.</code><codeclass="descname">PscRegistration</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.PscRegistration"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PscRegistration</span></code> class provides methods to get and set the
PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This
class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>https_port=None</em>, <em>sso_domain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.PscRegistration.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the PSC this appliance is
registered with. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The HTTPs port used by the external PSC. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Single Sign-On domain name of the external PSC. This attribute
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.PscRegistration.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information of the PSC that this appliance is registered with. This
<codeclass="descname">repoint</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.PscRegistration.repoint"title="Permalink to this definition">¶</a></dt>
<dd><p>Repoint this vCenter Server appliance to a different external PSC. This
method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.RemotePscSpec"title="com.vmware.vcenter.deployment_client.RemotePscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) – RemotePscSpec structure containing information about the external
PSC node to repoint this vCenter Server appliance to.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.system_config_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-tokenservice-client-module"></span><h2>com.vmware.vcenter.tokenservice_client module<aclass="headerlink"href="#module-com.vmware.vcenter.tokenservice_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">exception </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">Error</code><spanclass="sig-paren">(</span><em>messages=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.Error"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Error</span></code> exception describes theattributes common to all standard
exceptions.</p>
<blockquote>
<div><p>This exception serves two purposes:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>It is the exception that clients in many programming languages can catch
to handle all standard exceptions. Typically those clients will display one
or more of the localizable messages from <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Error.messages</span></code> to a human.</p></li>
<li><p>It is the exception that methods can report when they need to report
some exception, but the exception doesn’t fit into any other standard
exception, and in fact the only reasonable way for a client to react to the
exception is to display the message(s) to a human.</p></li>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
null, null, and null classes are intended as possible values for
this attribute. <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may
also be useful as a value for this attribute (although that is not
its primary purpose). Some classes may provide their own specific
classes for use as the value of this attribute when reporting
exceptions from their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property">exception </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">InvalidGrant</code><spanclass="sig-paren">(</span><em>messages=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.InvalidGrant"title="Permalink to this definition">¶</a></dt>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
null, null, and null classes are intended as possible values for
this attribute. <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may
also be useful as a value for this attribute (although that is not
its primary purpose). Some classes may provide their own specific
classes for use as the value of this attribute when reporting
exceptions from their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property">exception </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">InvalidRequest</code><spanclass="sig-paren">(</span><em>messages=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.InvalidRequest"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InvalidRequest</span></code> exception indicates that
<aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec</span></code></a> is missing a required parameter,
includes an unsupported parameter value (other than
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec.grant_type</span></code>). <strong>Warning:</strong> This class is
available as technical preview. It may be changed in a future release.</p>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
null, null, and null classes are intended as possible values for
this attribute. <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may
also be useful as a value for this attribute (although that is not
its primary purpose). Some classes may provide their own specific
classes for use as the value of this attribute when reporting
exceptions from their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property">exception </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">InvalidScope</code><spanclass="sig-paren">(</span><em>messages=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.InvalidScope"title="Permalink to this definition">¶</a></dt>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
null, null, and null classes are intended as possible values for
this attribute. <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may
also be useful as a value for this attribute (although that is not
its primary purpose). Some classes may provide their own specific
classes for use as the value of this attribute when reporting
exceptions from their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.tokenservice_client.</code><codeclass="descname">TokenExchange</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TokenExchange</span></code> interface provides possibility to exchange between
different tokens types. Implementation of “OAuth 2.0 Token Exchange”
standard (<aclass="reference external"href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12</a>).
<strong>Warning:</strong> This class is available as technical preview. It may be
changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">ACCESS_TOKEN_TYPE</code><emclass="property"> = 'urn:ietf:params:oauth:token-type:access_token'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ACCESS_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates OAuth 2.0 access token type. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<codeclass="descname">BEARER_TOKEN_METHOD_TYPE</code><emclass="property"> = 'Bearer'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.BEARER_TOKEN_METHOD_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates that the security token is a bearer token.
<strong>Warning:</strong> This class attribute is available as technical preview. It may be
<li><p><strong>grant_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of <aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"title="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.TOKEN_EXCHANGE_GRANT</span></code></a> indicates
that a token exchange is being performed. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>resource</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates the location of the target service or resource where the
client intends to use the requested security token. <strong>Warning:</strong>
This attribute is available as technical preview. It may be changed
in a future release.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>audience</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The logical name of the target service where the client intends to
use the requested security token. This serves a purpose similar to
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec.resource</span></code> parameter, but with
the client providing a logical name rather than a location.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>scope</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of space-delimited, case-sensitive strings, that allow the
client to specify the desired scope of the requested security token
in the context of the service or resource where the token will be
used. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>requested_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier for the type of the requested security token. If the
requested type is unspecified, the issued token type is at the
discretion of the server and may be dictated by knowledge of the
requirements of the service or resource indicated by the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec.resource</span></code> or
This attribute is available as technical preview. It may be changed
in a future release.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>subject_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A security token that represents the identity of the party on
behalf of whom exchange is being made. Typically, the subject of
this token will be the subject of the security token issued. Token
is base64-encoded. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</p></li>
<li><p><strong>subject_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.</p></li>
<li><p><strong>actor_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A security token that represents the identity of the acting party.
Typically, this will be the party that is authorized to use the
requested security token and act on behalf of the subject.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
if not needed for specific case of exchange.</p></li>
<li><p><strong>actor_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier, that indicates the type of the security token in the
<codeclass="descname">ID_TOKEN_TYPE</code><emclass="property"> = 'urn:ietf:params:oauth:token-type:id_token'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ID_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates OIDC ID token type. <strong>Warning:</strong> This class attribute
is available as technical preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>access_token=None</em>, <em>issued_token_type=None</em>, <em>token_type=None</em>, <em>expires_in=None</em>, <em>scope=None</em>, <em>refresh_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>access_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The security token issued by the server in response to the token
exchange request. Token is base64-encoded. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.</p></li>
<li><p><strong>issued_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
This attribute is available as technical preview. It may be changed
in a future release.</p></li>
<li><p><strong>token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A case-insensitive value specifying the method of using the access
token issued. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.</p></li>
<li><p><strong>expires_in</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The validity lifetime, in seconds, of the token issued by the
server. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
if not applicable for issued token.</p></li>
<li><p><strong>scope</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Scope of the issued security token. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.
if the scope of the issued security token is identical to the scope
requested by the client.</p></li>
<li><p><strong>refresh_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A refresh token can be issued in cases where the client of the
token exchange needs the ability to access a resource even when the
original credential is no longer valid. <strong>Warning:</strong> This attribute
is available as technical preview. It may be changed in a future
release.
if not needed for specific case of exchange.</p></li>
<codeclass="descname">N_A_TOKEN_METHOD_TYPE</code><emclass="property"> = 'N_A'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">REFRESH_TOKEN_TYPE</code><emclass="property"> = 'urn:ietf:params:oauth:token-type:refresh_token'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.REFRESH_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates OAuth 2.0 refresh token type. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<codeclass="descname">SAML1_TOKEN_TYPE</code><emclass="property"> = 'urn:ietf:params:oauth:token-type:saml1'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML1_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates base64-encoded SAML 1.1 token type. <strong>Warning:</strong> This
class attribute is available as technical preview. It may be changed in a
<codeclass="descname">SAML2_TOKEN_TYPE</code><emclass="property"> = 'urn:ietf:params:oauth:token-type:saml2'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML2_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates base64-encoded SAML 2.0 token type. <strong>Warning:</strong> This
class attribute is available as technical preview. It may be changed in a
<codeclass="descname">TOKEN_EXCHANGE_GRANT</code><emclass="property"> = 'urn:ietf:params:oauth:grant-type:token-exchange'</em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates that token exchange grant type. <strong>Warning:</strong> This
class attribute is available as technical preview. It may be changed in a
<codeclass="descname">exchange</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.exchange"title="Permalink to this definition">¶</a></dt>
<dd><p>Exchanges incoming token based on the spec and current client
authorization data. <strong>Warning:</strong> This method is available as technical
preview. It may be changed in a future release.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec</span></code></a>) –<codeclass="docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments that define
<ddclass="field-odd"><p><aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info"title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TokenExchange.Info</span></code></a> class that contains new token.</p>
<spanid="com-vmware-vcenter-topology-client-module"></span><h2>com.vmware.vcenter.topology_client module<aclass="headerlink"href="#module-com.vmware.vcenter.topology_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.topology_client.</code><codeclass="descname">Nodes</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes</span></code> interface provides methods to retrieve vCenter and Platform
Services Controller nodes information in the topology. This class was added
in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">ApplianceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code> class defines values for valid appliance types
for the vCenter and Platform Services Controller node. See
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.Info"title="com.vmware.vcenter.topology_client.Nodes.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.Info</span></code></a>. This enumeration was added in vSphere API 6.7.2.</p>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">PSC_EXTERNAL</code><emclass="property"> = ApplianceType(string='PSC_EXTERNAL')</em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
<codeclass="descname">VCSA_EMBEDDED</code><emclass="property"> = ApplianceType(string='VCSA_EMBEDDED')</em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
<codeclass="descname">VCSA_EXTERNAL</code><emclass="property"> = ApplianceType(string='VCSA_EXTERNAL')</em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>types=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code> class contains attribute used to filter the
results when listing vCenter and Platform Services Controller nodes (see
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.list"title="com.vmware.vcenter.topology_client.Nodes.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Nodes.list()</span></code></a>). This class was added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Types of the appliance that a vCenter and Platform Services
Controller node must be to match the filter (see
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>. This attribute was added in vSphere
API 6.7.2.
If None or empty, node of any ApplianceType match the filter.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>domain=None</em>, <em>type=None</em>, <em>replication_partners=None</em>, <em>client_affinity=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.Info</span></code> class contains vCenter or Platform Services Controller
node details. This class was added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>) – Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of replication partners’ node identifiers. Identifiers can be
either IP address or DNS resolvable name of the partner node. This
attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>node=None</em>, <em>type=None</em>, <em>replication_partners=None</em>, <em>client_affinity=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.Summary</span></code> class contains commonly used information of vCenter
or Platform Services Controller node. This class was added in vSphere API
6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>node</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
node. This attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>) – Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of replication partners’ node identifiers. Identifiers can be
either IP address or DNS resolvable name of the partner node. This
attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>node</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve details for a given identifier of the vCenter or Platform
Services Controller node. This method was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>node</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about all vCenter and Platform Services Controller
nodes matching the <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a>. This method was added in
vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a>
with all attributes None which means all nodes match the filter.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.topology_client.</code><codeclass="descname">Pscs</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Pscs"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pscs</span></code> class provides methods to decommission the external Platform
Services Controller node. This class was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">DecommissionSpec</code><spanclass="sig-paren">(</span><em>sso_admin_username=None</em>, <em>sso_admin_password=None</em>, <em>ssl_thumbprint=None</em>, <em>ssl_verify=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Pscs.DecommissionSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator username for example
“administrator\@vsphere.local”. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the external Platform Services Controller node
to be decommissioned that will be used for verification. This
attribute was added in vSphere API 6.7.2.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> or
has the value true. No verification will be performed if
<codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> value is set to false.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
<codeclass="descname">decommission_task</code><spanclass="sig-paren">(</span><em>hostname</em>, <em>spec</em>, <em>only_precheck=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Pscs.decommission_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Decommission the external Platform Services Controller node. This
method was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – FQDN or IP address of external Platform Services Controller node to
be decommissioned.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Pscs.DecommissionSpec"title="com.vmware.vcenter.topology_client.Pscs.DecommissionSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pscs.DecommissionSpec</span></code></a>) – Information needed to decommission the external Platform Services
Controller node.</p></li>
<li><p><strong>only_precheck</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether only a pre-check should be performed.
If None the full decommission will be performed.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.topology_client.</code><codeclass="descname">ReplicationStatus</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.ReplicationStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus</span></code> interface provides methods to retrieve
replication status information of vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>).
This class was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>nodes=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code> class contains attribute used to
filter the results when listing replication status for the vCenter and
Platform Services Controller nodes (see <aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.list"title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ReplicationStatus.list()</span></code></a>) of
type VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>). This class
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>node=None</em>, <em>replication_partner=None</em>, <em>partner_available=None</em>, <em>status_available=None</em>, <em>replicating=None</em>, <em>change_lag=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.ReplicationStatus.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary</span></code> class contains replication information of
partner vCenter or Platform Services Controller node of type
VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>). This class was
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>replication_partner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the vCenter or Platform Services Controller
replication partner. Identifier can be either IP address or DNS
resolvable name of the replication partner. This attribute was
added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>partner_available</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the VMware Directory Service on partner is reachable
or not. This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>status_available</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the replication status for the node with respect to
replication partner can be retrieved or not. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>replicating</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates if node is processing replication changes from the
replication partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.partner_available</span></code> or
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
<li><p><strong>change_lag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of replication changes node is behind the replication
partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.partner_available</span></code> or
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.ReplicationStatus.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the replication information of vCenter and Platform Services
Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>) matching the
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a>. This method was added in vSphere
API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a> with all attributes None
which means all vCenter and Platform Services Controller nodes of
type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.topology_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vcha-client-module"></span><h2>com.vmware.vcenter.vcha_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vcha_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client</span></code> module provides classes for deploying
and monitoring a vCenter High Availability (VCHA) Cluster.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">CertificateInfo</code><spanclass="sig-paren">(</span><em>ssl_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.CertificateInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SHA-256 thumbprint of the SSL certificate for a management
vCenter server. This attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">Cluster</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster</span></code> class provides methods to deploy and undeploy a vCenter
High Availability (VCHA) cluster, failover from the active VCHA node to the
passive VCHA node, and retrieve the status of the VCHA cluster. This class
was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">ActiveSpec</code><spanclass="sig-paren">(</span><em>ha_network_type=None</em>, <em>ha_network=None</em>, <em>ha_ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
unset, then the second NIC is assumed to be already configured.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute must be
set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code>
attribute is unset, then the second NIC is assumed to be already
configured.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
<emclass="property">class </em><codeclass="descname">ClusterMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DISABLED</code><emclass="property"> = ClusterMode(string='DISABLED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA Cluster is disabled. State replication between the Active and Passive
node is disabled and automatic failover is not allowed. This class
<codeclass="descname">ENABLED</code><emclass="property"> = ClusterMode(string='ENABLED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.ENABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA Cluster is enabled. State replication between the Active and Passive
node is enabled and automatic failover is allowed. This class attribute was
<codeclass="descname">MAINTENANCE</code><emclass="property"> = ClusterMode(string='MAINTENANCE')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.MAINTENANCE"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA Cluster is in maintenance mode. State replication between the Active
and Passive node is enabled but automatic failover is not allowed. This
class attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descname">ClusterState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ClusterState</span></code> class defines the possible for a VCHA Cluster.
This enumeration was added in vSphere API 6.7.1.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterState</span></code> instance.</p>
<codeclass="descname">DEGRADED</code><emclass="property"> = ClusterState(string='DEGRADED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.DEGRADED"title="Permalink to this definition">¶</a></dt>
<dd><p>A VCHA Cluster is said to be in a degraded state for either or all of the
following reasons:</p>
<ulclass="simple">
<li><p>There is a node loss.</p></li>
<li><p>State replication between the Active and Passive node fails.</p></li>
</ul>
<p>. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="descname">HEALTHY</code><emclass="property"> = ClusterState(string='HEALTHY')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.HEALTHY"title="Permalink to this definition">¶</a></dt>
<dd><p>All three nodes in a VCHA Cluster are healthy and connected. State
replication between Active and Passive node is working and both nodes are
in sync. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="descname">ISOLATED</code><emclass="property"> = ClusterState(string='ISOLATED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.ISOLATED"title="Permalink to this definition">¶</a></dt>
<dd><p>All three nodes are isolated from each other. This class attribute was
<emclass="property">class </em><codeclass="descname">ConfigState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ConfigState</span></code> class defines the VCHA configuration state.
This enumeration was added in vSphere API 6.7.1.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConfigState</span></code> instance.</p>
<codeclass="descname">CONFIGURED</code><emclass="property"> = ConfigState(string='CONFIGURED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.CONFIGURED"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA cluster is configured. This class attribute was added in vSphere API
<codeclass="descname">INVALID</code><emclass="property"> = ConfigState(string='INVALID')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.INVALID"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA cluster is in an invalid/dirty state. This class attribute was added
<codeclass="descname">NOTCONFIGURED</code><emclass="property"> = ConfigState(string='NOTCONFIGURED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.NOTCONFIGURED"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA cluster is not configured. This class attribute was added in vSphere
<codeclass="descname">PREPARED</code><emclass="property"> = ConfigState(string='PREPARED')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.PREPARED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter server appliance has been prepared for VCHA cluster configuration.
This class attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descname">DeploySpec</code><spanclass="sig-paren">(</span><em>vc_spec=None</em>, <em>deployment=None</em>, <em>active=None</em>, <em>passive=None</em>, <em>witness=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>vc_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>deployment</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Type"title="com.vmware.vcenter.vcha_client.Cluster.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Type</span></code></a>) – Contains the deployment type. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>active</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"title="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec</span></code></a>) – Contains the active node’s network configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>passive</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"title="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.PassiveSpec</span></code></a>) – Contains the passive node’s placement configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"title="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.WitnessSpec</span></code></a>) – Contains the witness node’s placement configuration. This attribute
<emclass="property">class </em><codeclass="descname">ErrorCondition</code><spanclass="sig-paren">(</span><em>error=None</em>, <em>recommendation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"title="Permalink to this definition">¶</a></dt>
<li><p><strong>error</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Contains an error condition. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>recommendation</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains a recommendation on handling the error condition. This
attribute was added in vSphere API 6.7.1.
If None, there is no tip for the error condition.</p></li>
<li><p><strong>config_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState"title="com.vmware.vcenter.vcha_client.Cluster.ConfigState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ConfigState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration state of the VCHA cluster.
The active node’s management vCenter server credentials are not
required to populate this attribute. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable.</p></li>
<li><p><strong>node1</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable.</p></li>
<li><p><strong>node2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"title="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode"title="com.vmware.vcenter.vcha_client.Cluster.ClusterMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ClusterMode</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Operational mode of the VCHA Cluster. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>health_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState"title="com.vmware.vcenter.vcha_client.Cluster.ClusterState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ClusterState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known state of the VCHA Cluster. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>health_exception</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Health warning messages if the health information is unavailable.
This attribute was added in vSphere API 6.7.1.
If None, then the cluster is in a healthy state.</p></li>
<li><p><strong>health_warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"title="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ErrorCondition</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A collection of messages describing the reason for a non-healthy
Cluster. This attribute was added in vSphere API 6.7.1.
If None, then the cluster is in a healthy state.</p></li>
<li><p><strong>manual_failover_allowed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies if manual failover is allowed. This attribute was added
in vSphere API 6.7.1.
If None, then the cluster state healthy and manual failover
allowance in accordance with the cluster mode.</p></li>
<li><p><strong>auto_failover_allowed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies if automatic failover is allowed. This attribute was
added in vSphere API 6.7.1.
If None, then the cluster state healthy and automatic failover
allowance in accordance with the cluster mode.</p></li>
<emclass="property">class </em><codeclass="descname">IpFamily</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.IpFamily</span></code> class defines the IP address family. This
enumeration was added in vSphere API 6.7.1.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">IPV4</code><emclass="property"> = IpFamily(string='IPV4')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="descname">IPV6</code><emclass="property"> = IpFamily(string='IPV6')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV6 address family. This class attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descname">IpInfo</code><spanclass="sig-paren">(</span><em>ip_family=None</em>, <em>ipv4=None</em>, <em>ipv6=None</em>, <em>gateway_ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>ip_family</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpFamily</span></code></a>) – Family of the ip. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"title="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Ipv4Info</span></code></a>) – If the type of the ip family is IPV4, then this will point to IPv4
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"title="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Ipv6Info</span></code></a>) – If the type of the ip family is IPV6, then this will point to IPv6
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>gateway_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Gateway IP address. This attribute was added in vSphere API 6.7.1.
<emclass="property">class </em><codeclass="descname">Ipv4Info</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>subnet_mask=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The subnet mask of the interface. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR prefix of the interface. This attribute was added in
vSphere API 6.7.1.
If None , then the subnet mask is invalid.</p></li>
<emclass="property">class </em><codeclass="descname">Ipv6Info</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The CIDR prefix of the interface. This attribute was added in
<emclass="property">class </em><codeclass="descname">NodeInfo</code><spanclass="sig-paren">(</span><em>failover_ip=None</em>, <em>ha_ip=None</em>, <em>runtime=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>failover_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Failover IP address that this node will assume after the failover
to serve client requests. Each failover node can have a different
failover IP address.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.failover_ip</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then it will assume the public IP address of the Active
vCenter Server.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a>) – VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active node’s management vCenter server credentials are not
required to populate this <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Runtime information for the node in the VCHA Cluster.
The active node’s management vCenter server credentials are
required to populate some attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.runtime</span></code>. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the specified
Active vCenter server management credentials are invalid or the
<emclass="property">class </em><codeclass="descname">NodeRole</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ACTIVE</code><emclass="property"> = NodeRole(string='ACTIVE')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.ACTIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Active. In this role, node runs a vCenter Server
that serves client requests. This class attribute was added in vSphere API
<codeclass="descname">PASSIVE</code><emclass="property"> = NodeRole(string='PASSIVE')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.PASSIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Passive. In this role node, runs as a standby for
the Active vCenter Server and receives state updates. This node takes over
the role of Active vCenter Server upon failover. This class attribute was
<codeclass="descname">WITNESS</code><emclass="property"> = NodeRole(string='WITNESS')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.WITNESS"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Witness. In this role, node acts as a quorum node
for avoiding the classic split-brain problem. This class attribute was
<emclass="property">class </em><codeclass="descname">NodeRuntimeInfo</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>role=None</em>, <em>placement=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code> class describes a node’s runtime
information in a VCHA Cluster. This class was added in vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState"title="com.vmware.vcenter.vcha_client.Cluster.NodeState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known state of the node.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.state</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then information is unavailable or the passive and witness
nodes are not cloned yet.</p></li>
<li><p><strong>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole"title="com.vmware.vcenter.vcha_client.Cluster.NodeRole"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRole</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known role of the node.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.role</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then information is unavailable or the passive and witness
nodes are not cloned yet.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementInfo"title="com.vmware.vcenter.vcha_client.PlacementInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Placement information of the node.
The active node’s management vCenter server credentials are
required to populate most attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.placement</span></code>. This attribute was added
in vSphere API 6.7.1.
If None, then the information is unavailable or the specified
Active vCenter server management credentials are invalid or the
node is not cloned yet or the VCHA cluster was deployed in a manual
<emclass="property">class </em><codeclass="descname">NodeState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DOWN</code><emclass="property"> = NodeState(string='DOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.DOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is down and has left the VCHA Cluster. This class attribute was added
<codeclass="descname">UP</code><emclass="property"> = NodeState(string='UP')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.UP"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is up and has joined the VCHA Cluster. This class attribute was added
<emclass="property">class </em><codeclass="descname">NodeVmInfo</code><spanclass="sig-paren">(</span><em>vm=None</em>, <em>bios_uuid=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code> class contains information to describe the
Virtual Machine of a node of a VCHA cluster. This class was added in
vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine of the VCHA node. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine:VCenter</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine:VCenter</span></code>.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">PassiveSpec</code><spanclass="sig-paren">(</span><em>placement=None</em>, <em>ha_ip=None</em>, <em>failover_ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.PassiveSpec</span></code> class contains the deploy specification for the
Passive Node of the VCHA cluster. This class was added in vSphere API
6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the placement configuration of the node. This attribute
was added in vSphere API 6.7.1.
If None, then the it is assumed that the clone will be done
manually by the customer. In this case, the placement configuration
for the witness node should also be omitted. Only the network
configuration will be setup. Once the passive and witness nodes are
cloned from the active node, the VCHA high availability is turned
on.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>failover_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP specification for the management network. This attribute was
added in vSphere API 6.7.1.
If None, then it will assume the public IP address of the Active
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">AUTO</code><emclass="property"> = Type(string='AUTO')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.Type.AUTO"title="Permalink to this definition">¶</a></dt>
<dd><p>Passive and witness nodes are cloned automatically. This class attribute
<codeclass="descname">MANUAL</code><emclass="property"> = Type(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.Type.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Passive and witness nodes are not cloned automatically. After deployment,
the customer should clone the passive and witness virtual machines. This
class attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descname">UndeploySpec</code><spanclass="sig-paren">(</span><em>vc_spec=None</em>, <em>force_delete=None</em>, <em>vms=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>vc_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>force_delete</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag controlling in what circumstances the virtual machines will be
deleted. For this flag to take effect, the VCHA cluster should have
been successfully configured using automatic deployment.</p>
<ul>
<li><p>If true, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute will be
ignored, the VCHA cluster specific information is removed, and the
passive and witness virtual machines will be deleted.</p></li>
the information identifying the passive and witness virtual
machines.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines and VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is None, then
the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
the information identifying the passive and witness virtual
machines.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines. VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is None, then
the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed.</p></li>
</ul>
</p></li>
<li><p><strong>vms</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo"title="com.vmware.vcenter.vcha_client.Cluster.VmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.VmInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Contains virtual machine information for the passive and witness
virtual machines. For this flag to take effect, the VCHA cluster
should have been successfully configured using automatic
deployment.</p>
<p>If set, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls whether this information is validated.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then this information is ignored, VCHA cluster specific
information is removed and the passive and witness virtual machines
will be deleted.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
None or false, then this information is validated prior to deleting
the passive and witness virtual machines. VCHA cluster specific
information is removed.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls the deletion of the passive and witness virtual machines.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then the passive and witness virtual machines will be
deleted. VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
None or false, then the passive and witness virtual machines will
not be deleted. The customer should delete them in order to cleanup
completely. VCHA cluster specific information is removed.</p></li>
<emclass="property">class </em><codeclass="descname">VmInfo</code><spanclass="sig-paren">(</span><em>passive=None</em>, <em>witness=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.VmInfo</span></code> class contains information to describe the Virtual
Machines of passive and witness nodes of a VCHA cluster. This class was
added in vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>passive</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code></a>) – The virtual machine information of the passive node. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code></a>) – The virtual machine information of the witness node. This attribute
<emclass="property">class </em><codeclass="descname">WitnessInfo</code><spanclass="sig-paren">(</span><em>ha_ip=None</em>, <em>runtime=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo</span></code> class defines the configuration and runtime
information for the witness node in the cluster. This class was added in
vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a>) – VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Runtime information for the node in the VCHA Cluster.
The active node’s management vCenter server credentials are
required to populate some attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo.runtime</span></code>. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
<emclass="property">class </em><codeclass="descname">WitnessSpec</code><spanclass="sig-paren">(</span><em>placement=None</em>, <em>ha_ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.WitnessSpec</span></code> class contains the deploy specification for the
Witness Node of the VCHA cluster. This class was added in vSphere API
6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the placement configuration of the node. This attribute
was added in vSphere API 6.7.1.
If None, then it is assumed that the clone will be done manually by
the customer. In this case, the placement configuration for the
witness node should also be omitted. Only the network configuration
will be setup. Once the passive and witness nodes are cloned from
the active node, the VCHA high availability is turned on.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
<codeclass="descname">deploy_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.deploy_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Prepares, clones, and configures a VCHA cluster. This method was added
in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec"title="com.vmware.vcenter.vcha_client.Cluster.DeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.DeploySpec</span></code></a>) – Contains the deploy specification for all three nodes of a VCHA
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<codeclass="descname">failover_task</code><spanclass="sig-paren">(</span><em>planned</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.failover_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates failover from the active vCenter node to the passive node.</p>
<p>For forced failover, Active node immediately initiates a failover. This
may result into a data loss after failover.</p>
<p>For planned failover, Active node flushes all the state to the Passive
node, waits for the flush to complete before causing a failover. After
the failover, Passive node starts without any data loss.</p>
<blockquote>
<div><p>A failover is allowed only in the following cases:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>Cluster’s mode is enabled and all cluster members are present.</p></li>
<li><p>Cluster’s mode is maintenance and all cluster members are present.</p></li>
</ol>
<p>. This method was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>planned</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – If false, a failover is initiated immediately and may result in
data loss.
If true, a failover is initated after the Active node flushes its
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vc_spec=None</em>, <em>partial=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the status of a VCHA cluster. This method was added in
vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vc_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains active node’s management vCenter server credentials.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>partial</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>If true, then return only the information that does not require
connecting to the Active vCenter Server.</p>
<blockquote>
<div><p>If false or unset, then return all the information.</p>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<codeclass="descname">undeploy_task</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.undeploy_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Destroys the VCHA cluster and removes all VCHA specific information
from the VCVA appliance. Optionally, the passive and witness node
virtual machines will be deleted only if VCHA was deployed using
automatic deployment. The active node in the cluster continues to run
as a standalone VCVA appliance after the destroy operation has been
performed.</p>
<p>If the VCHA cluster is in a transition state and not configured, then
the VCHA cluster specific information is removed.. This method was
added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"title="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec</span></code></a>) – Contains the undeploy specification for a VCHA cluster.</p>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">ConnectionSpec</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>port=None</em>, <em>ssl_thumbprint=None</em>, <em>username=None</em>, <em>password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.ConnectionSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP Address or DNS of the vCenter. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Port number. This attribute was added in vSphere API 6.7.1.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 hash of the server SSL certificate. This attribute was added
in vSphere API 6.7.1.
If None, empty ssl thumbprint is assumed.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Username to access the server. This attribute was added in vSphere
API 6.7.1.
This attribute is currently required. If None, an error is
returned. In the future, if this attribute is None, the system will
attempt to identify the user. If a user cannot be identified, then
the requested operation will fail.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Password for the specified user. This attribute was added in
vSphere API 6.7.1.
This attribute is currently required. If None, an empty password is
assumed. In the future, if this attribute is None, the system will
attempt to authenticate the user. If a user cannot be identified,
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">CredentialsSpec</code><spanclass="sig-paren">(</span><em>active_location=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>active_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.ConnectionSpec"title="com.vmware.vcenter.vcha_client.ConnectionSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionSpec</span></code></a>) – Connection information for the management vCenter Server of the
Active Node in a VCHA Cluster. This attribute was added in vSphere
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">DiskInfo</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>datastore_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.DiskInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the datastore to put all the virtual disks on.
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datastore. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">DiskSpec</code><spanclass="sig-paren">(</span><em>datastore=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.DiskSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the datastore to put all the virtual disks on.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">IpFamily</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpFamily"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpFamily</span></code> class defines the Ip address family. This enumeration was
added in vSphere API 6.7.1.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily"title="com.vmware.vcenter.vcha_client.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpFamily</span></code></a> instance.</p>
<codeclass="descname">IPV4</code><emclass="property"> = IpFamily(string='IPV4')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="descname">IPV6</code><emclass="property"> = IpFamily(string='IPV6')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6"title="Permalink to this definition">¶</a></dt>
<dd><p>IPv6 address family. This class attribute was added in vSphere API 6.7.1.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">IpSpec</code><spanclass="sig-paren">(</span><em>ip_family=None</em>, <em>ipv4=None</em>, <em>ipv6=None</em>, <em>default_gateway=None</em>, <em>dns_servers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpSpec</span></code> class contains IP information used to configure a network
interface. This class was added in vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ip_family</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily"title="com.vmware.vcenter.vcha_client.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpFamily</span></code></a>) – Family of the IP address to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Ipv4Spec"title="com.vmware.vcenter.vcha_client.Ipv4Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Spec</span></code></a>) – If the family of the ip is IPV4, then this will point to IPv4
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4"title="com.vmware.vcenter.vcha_client.IpFamily.IPV4"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Ipv6Spec"title="com.vmware.vcenter.vcha_client.Ipv6Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6Spec</span></code></a>) – If the family of the ip is IPV6, then this will point to IPv6
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6"title="com.vmware.vcenter.vcha_client.IpFamily.IPV6"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The IP address of the Gateway for this interface. This attribute
was added in vSphere API 6.7.1.
If None, gateway will not be used for the network interface.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of IP addresses of the DNS servers for this interface.
This list is a comma separated list. This attribute was added in
vSphere API 6.7.1.
If None, DNS servers will not be used for the network interface.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">Ipv4Spec</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>subnet_mask=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Ipv4Spec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IPV4 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The subnet mask for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute is None, then an error will be
reported.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute is set, then the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code>
attribute will be used to create a subnet mask whose first prefix
bits are 1 and the remaining bits 0.
If both the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
will be reported.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR prefix for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute is None, this an error
will be reported.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute is set, then the
<codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute will be used.
If both the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">Ipv6Spec</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Ipv6Spec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IPv6 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The CIDR prefix for the interface. This attribute was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">NetworkType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.NetworkType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NetworkType</span></code> class defines the type of a vCenter Server network.
This enumeration was added in vSphere API 6.7.1.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> instance.</p>
<codeclass="descname">DISTRIBUTED_PORTGROUP</code><emclass="property"> = NetworkType(string='DISTRIBUTED_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.NetworkType.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>Distributed virtual switch. This class attribute was added in vSphere API
<codeclass="descname">STANDARD_PORTGROUP</code><emclass="property"> = NetworkType(string='STANDARD_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.NetworkType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network. This class attribute was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">Operations</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Operations</span></code> class provides methods to figure out the currently
active operations and currently disabled operations in a vCenter High
Availability (VCHA) cluster. This class was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">CLUSTER_DEPLOY_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.deploy'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster deploy operation. This class attribute was added in
<codeclass="descname">CLUSTER_FAILOVER_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.failover'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster failover operation. This class attribute was added in
<codeclass="descname">CLUSTER_GET_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.get'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster get operation. This class attribute was added in
<codeclass="descname">CLUSTER_UNDEPLOY_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.undeploy'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster undeploy operation. This class attribute was added in
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>disabled=None</em>, <em>active=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>disabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the operations that are current disabled. These
operation strings are one of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a> and
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_GET_OP</span></code></a>. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>active</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the operations that are currently running. These
operation strings are one of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.MODE_SET_OP</span></code></a>, and
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a>. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<codeclass="descname">MODE_GET_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.mode.get'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.MODE_GET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the get mode operation. This class attribute was added in vSphere
<codeclass="descname">MODE_SET_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.mode.set'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the set mode operation. This class attribute was added in vSphere
<codeclass="descname">PASSIVE_REDEPLOY_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.passive.redeploy'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the passive redeploy operation. This class attribute was added in
<codeclass="descname">WITNESS_REDEPLOY_OP</code><emclass="property"> = 'com.vmware.vcenter.vcha.cluster.witness.redeploy'</em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the witness redeploy operation. This class attribute was added in
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the current active and disabled operations of a VCHA cluster.
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PlacementInfo</span></code> class contains information to describe the inventory
placement of a single node of a VCHA cluster.
The active node’s management vCenter server credentials are required to
populate all attributes except biosUuid. This class was added in vSphere
API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>management_vcenter_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The hostname of the vCenter server that is managing the VCHA node.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>vm_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The virtual machine name of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>datacenter</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the datacenter of the VCHA node. This attribute
was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datacenter:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>datacenter_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datacenter of the VCHA node. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the host of the VCHA node. This attribute was
added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>host_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the host of the VCHA node. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the cluster of which <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is member. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource:VCenter</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource:VCenter</span></code>.
If None, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the cluster of which <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is member. This attribute
was added in vSphere API 6.7.1.
If None, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>ha_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>management_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the Network object used for the Management
network. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>management_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>management_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a>) – The type of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.DiskInfo"title="com.vmware.vcenter.vcha_client.DiskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskInfo</span></code></a>) – The storage information of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
6.7.1.
If None, the information is currently unavailable.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code> class contains information to describe the inventory
placement of a single node of a VCHA cluster. This class was added in
vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the VCHA node to be used for the virtual machine name.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the folder to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Folder:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the host to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the resource pool to deploy the VCHA node to.
This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
If None, then the active node’s resource pool will be used.</p></li>
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is
unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set,
then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
{#link #haNetworkType} attribute must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is
unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.</p></li>
<li><p><strong>management_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the Management network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is set,
then the {#link #managementNetworkType} field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is set, then an error is reported.</p></li>
<li><p><strong>management_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the Management
network. If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is set, then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code>
attribute must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code>
attribute is unset, then the same network present on the Active
node virtual machine is used to deploy the virtual machine with an
assumption that the network is present on the destination.</p></li>
<li><p><strong>storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.DiskSpec"title="com.vmware.vcenter.vcha_client.DiskSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The storage specification to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
If None, see vim.vm.RelocateSpec.datastore.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vcha_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-client-module"></span><h2>com.vmware.vcenter.vm_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
virtual machines.</p>
<dlclass="class">
<dtid="com.vmware.vcenter.vm_client.GuestOS">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">GuestOS</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">AMAZONLINUX2_64</code><emclass="property"> = GuestOS(string='AMAZONLINUX2_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX2_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Amazon Linux 2 (64 bit). This class attribute was added in vSphere API
<codeclass="descname">ASIANUX_3</code><emclass="property"> = GuestOS(string='ASIANUX_3')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_3_64</code><emclass="property"> = GuestOS(string='ASIANUX_3_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_4</code><emclass="property"> = GuestOS(string='ASIANUX_4')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_4_64</code><emclass="property"> = GuestOS(string='ASIANUX_4_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_5_64</code><emclass="property"> = GuestOS(string='ASIANUX_5_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_7_64</code><emclass="property"> = GuestOS(string='ASIANUX_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ASIANUX_8_64</code><emclass="property"> = GuestOS(string='ASIANUX_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Asianux Server 8 (64 bit). This class attribute was added in vSphere API
<codeclass="descname">CENTOS</code><emclass="property"> = GuestOS(string='CENTOS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_6</code><emclass="property"> = GuestOS(string='CENTOS_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_64</code><emclass="property"> = GuestOS(string='CENTOS_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_6_64</code><emclass="property"> = GuestOS(string='CENTOS_6_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_7</code><emclass="property"> = GuestOS(string='CENTOS_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_7_64</code><emclass="property"> = GuestOS(string='CENTOS_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CENTOS_8_64</code><emclass="property"> = GuestOS(string='CENTOS_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">COREOS_64</code><emclass="property"> = GuestOS(string='COREOS_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.COREOS_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN</code><emclass="property"> = GuestOS(string='DARWIN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_10</code><emclass="property"> = GuestOS(string='DARWIN_10')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_10_64</code><emclass="property"> = GuestOS(string='DARWIN_10_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_11</code><emclass="property"> = GuestOS(string='DARWIN_11')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_11_64</code><emclass="property"> = GuestOS(string='DARWIN_11_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_12_64</code><emclass="property"> = GuestOS(string='DARWIN_12_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_13_64</code><emclass="property"> = GuestOS(string='DARWIN_13_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_14_64</code><emclass="property"> = GuestOS(string='DARWIN_14_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_15_64</code><emclass="property"> = GuestOS(string='DARWIN_15_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_16_64</code><emclass="property"> = GuestOS(string='DARWIN_16_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_17_64</code><emclass="property"> = GuestOS(string='DARWIN_17_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_18_64</code><emclass="property"> = GuestOS(string='DARWIN_18_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DARWIN_64</code><emclass="property"> = GuestOS(string='DARWIN_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_10</code><emclass="property"> = GuestOS(string='DEBIAN_10')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_10_64</code><emclass="property"> = GuestOS(string='DEBIAN_10_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_4</code><emclass="property"> = GuestOS(string='DEBIAN_4')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_4_64</code><emclass="property"> = GuestOS(string='DEBIAN_4_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_5</code><emclass="property"> = GuestOS(string='DEBIAN_5')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_5_64</code><emclass="property"> = GuestOS(string='DEBIAN_5_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_6</code><emclass="property"> = GuestOS(string='DEBIAN_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_6_64</code><emclass="property"> = GuestOS(string='DEBIAN_6_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_7</code><emclass="property"> = GuestOS(string='DEBIAN_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_7_64</code><emclass="property"> = GuestOS(string='DEBIAN_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_8</code><emclass="property"> = GuestOS(string='DEBIAN_8')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_8_64</code><emclass="property"> = GuestOS(string='DEBIAN_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_9</code><emclass="property"> = GuestOS(string='DEBIAN_9')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEBIAN_9_64</code><emclass="property"> = GuestOS(string='DEBIAN_9_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Debian GNU/Linux 9 (64 bit)</p>
</dd></dl>
<dlclass="attribute">
<dtid="com.vmware.vcenter.vm_client.GuestOS.DOS">
<codeclass="descname">DOS</code><emclass="property"> = GuestOS(string='DOS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DOS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ECOMSTATION</code><emclass="property"> = GuestOS(string='ECOMSTATION')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ECOMSTATION_2</code><emclass="property"> = GuestOS(string='ECOMSTATION_2')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FEDORA</code><emclass="property"> = GuestOS(string='FEDORA')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FEDORA_64</code><emclass="property"> = GuestOS(string='FEDORA_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD</code><emclass="property"> = GuestOS(string='FREEBSD')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD_11</code><emclass="property"> = GuestOS(string='FREEBSD_11')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD_11_64</code><emclass="property"> = GuestOS(string='FREEBSD_11_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD_12</code><emclass="property"> = GuestOS(string='FREEBSD_12')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD_12_64</code><emclass="property"> = GuestOS(string='FREEBSD_12_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FREEBSD_64</code><emclass="property"> = GuestOS(string='FREEBSD_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">GENERIC_LINUX</code><emclass="property"> = GuestOS(string='GENERIC_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MANDRAKE</code><emclass="property"> = GuestOS(string='MANDRAKE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRAKE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MANDRIVA</code><emclass="property"> = GuestOS(string='MANDRIVA')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MANDRIVA_64</code><emclass="property"> = GuestOS(string='MANDRIVA_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWARE_4</code><emclass="property"> = GuestOS(string='NETWARE_4')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWARE_5</code><emclass="property"> = GuestOS(string='NETWARE_5')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWARE_6</code><emclass="property"> = GuestOS(string='NETWARE_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NLD_9</code><emclass="property"> = GuestOS(string='NLD_9')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NLD_9"title="Permalink to this definition">¶</a></dt>
<dd><p>Novell Linux Desktop 9</p>
</dd></dl>
<dlclass="attribute">
<dtid="com.vmware.vcenter.vm_client.GuestOS.OES">
<codeclass="descname">OES</code><emclass="property"> = GuestOS(string='OES')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OES"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPENSERVER_5</code><emclass="property"> = GuestOS(string='OPENSERVER_5')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPENSERVER_6</code><emclass="property"> = GuestOS(string='OPENSERVER_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPENSUSE</code><emclass="property"> = GuestOS(string='OPENSUSE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPENSUSE_64</code><emclass="property"> = GuestOS(string='OPENSUSE_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX</code><emclass="property"> = GuestOS(string='ORACLE_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_6</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_64</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_6_64</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_6_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_7</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_7_64</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ORACLE_LINUX_8_64</code><emclass="property"> = GuestOS(string='ORACLE_LINUX_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OS2</code><emclass="property"> = GuestOS(string='OS2')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OS2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER</code><emclass="property"> = GuestOS(string='OTHER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_24X_LINUX</code><emclass="property"> = GuestOS(string='OTHER_24X_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_24X_LINUX_64</code><emclass="property"> = GuestOS(string='OTHER_24X_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_26X_LINUX</code><emclass="property"> = GuestOS(string='OTHER_26X_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_26X_LINUX_64</code><emclass="property"> = GuestOS(string='OTHER_26X_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_3X_LINUX</code><emclass="property"> = GuestOS(string='OTHER_3X_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_3X_LINUX_64</code><emclass="property"> = GuestOS(string='OTHER_3X_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_4X_LINUX</code><emclass="property"> = GuestOS(string='OTHER_4X_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_4X_LINUX_64</code><emclass="property"> = GuestOS(string='OTHER_4X_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux 4.x Kernel (64 bit). This class attribute was added in vSphere API
<codeclass="descname">OTHER_64</code><emclass="property"> = GuestOS(string='OTHER_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Other Operating System (64 bit) (experimental)</p>
<codeclass="descname">OTHER_LINUX</code><emclass="property"> = GuestOS(string='OTHER_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER_LINUX_64</code><emclass="property"> = GuestOS(string='OTHER_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">REDHAT</code><emclass="property"> = GuestOS(string='REDHAT')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.REDHAT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_2</code><emclass="property"> = GuestOS(string='RHEL_2')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_3</code><emclass="property"> = GuestOS(string='RHEL_3')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_3_64</code><emclass="property"> = GuestOS(string='RHEL_3_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_4</code><emclass="property"> = GuestOS(string='RHEL_4')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_4_64</code><emclass="property"> = GuestOS(string='RHEL_4_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_5</code><emclass="property"> = GuestOS(string='RHEL_5')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_5_64</code><emclass="property"> = GuestOS(string='RHEL_5_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Red Hat Enterprise Linux 5 (64 bit) (experimental)</p>
<codeclass="descname">RHEL_6</code><emclass="property"> = GuestOS(string='RHEL_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_6_64</code><emclass="property"> = GuestOS(string='RHEL_6_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_7</code><emclass="property"> = GuestOS(string='RHEL_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_7_64</code><emclass="property"> = GuestOS(string='RHEL_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RHEL_8_64</code><emclass="property"> = GuestOS(string='RHEL_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Red Hat Enterprise Linux 8 (64 bit). This class attribute was added in
<codeclass="descname">SJDS</code><emclass="property"> = GuestOS(string='SJDS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SJDS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SLES</code><emclass="property"> = GuestOS(string='SLES')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SLES_10</code><emclass="property"> = GuestOS(string='SLES_10')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SLES_10_64</code><emclass="property"> = GuestOS(string='SLES_10_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 10 (64 bit) (experimental)</p>
<codeclass="descname">SLES_11</code><emclass="property"> = GuestOS(string='SLES_11')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SLES_11_64</code><emclass="property"> = GuestOS(string='SLES_11_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 11 (64 bit)</p>
<codeclass="descname">SLES_12</code><emclass="property"> = GuestOS(string='SLES_12')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SLES_12_64</code><emclass="property"> = GuestOS(string='SLES_12_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 12 (64 bit)</p>
<codeclass="descname">SLES_15_64</code><emclass="property"> = GuestOS(string='SLES_15_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_15_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 15 (64 bit). This class attribute was added in
<codeclass="descname">SLES_64</code><emclass="property"> = GuestOS(string='SLES_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 9 (64 bit)</p>
<codeclass="descname">SOLARIS_10</code><emclass="property"> = GuestOS(string='SOLARIS_10')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_10_64</code><emclass="property"> = GuestOS(string='SOLARIS_10_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_11_64</code><emclass="property"> = GuestOS(string='SOLARIS_11_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_6</code><emclass="property"> = GuestOS(string='SOLARIS_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_7</code><emclass="property"> = GuestOS(string='SOLARIS_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_8</code><emclass="property"> = GuestOS(string='SOLARIS_8')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS_9</code><emclass="property"> = GuestOS(string='SOLARIS_9')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SUSE</code><emclass="property"> = GuestOS(string='SUSE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SUSE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SUSE_64</code><emclass="property"> = GuestOS(string='SUSE_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SUSE_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TURBO_LINUX</code><emclass="property"> = GuestOS(string='TURBO_LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TURBO_LINUX_64</code><emclass="property"> = GuestOS(string='TURBO_LINUX_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">UBUNTU</code><emclass="property"> = GuestOS(string='UBUNTU')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">UBUNTU_64</code><emclass="property"> = GuestOS(string='UBUNTU_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">UNIXWARE_7</code><emclass="property"> = GuestOS(string='UNIXWARE_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMKERNEL</code><emclass="property"> = GuestOS(string='VMKERNEL')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMKERNEL_5</code><emclass="property"> = GuestOS(string='VMKERNEL_5')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMKERNEL_6</code><emclass="property"> = GuestOS(string='VMKERNEL_6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMKERNEL_65</code><emclass="property"> = GuestOS(string='VMKERNEL_65')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMWARE_PHOTON_64</code><emclass="property"> = GuestOS(string='VMWARE_PHOTON_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_7</code><emclass="property"> = GuestOS(string='WINDOWS_7')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_7_64</code><emclass="property"> = GuestOS(string='WINDOWS_7_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_7_SERVER_64</code><emclass="property"> = GuestOS(string='WINDOWS_7_SERVER_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_8</code><emclass="property"> = GuestOS(string='WINDOWS_8')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_8_64</code><emclass="property"> = GuestOS(string='WINDOWS_8_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_8_SERVER_64</code><emclass="property"> = GuestOS(string='WINDOWS_8_SERVER_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_9</code><emclass="property"> = GuestOS(string='WINDOWS_9')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_9_64</code><emclass="property"> = GuestOS(string='WINDOWS_9_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_9_SERVER_64</code><emclass="property"> = GuestOS(string='WINDOWS_9_SERVER_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS_HYPERV</code><emclass="property"> = GuestOS(string='WINDOWS_HYPERV')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_2000_ADV_SERV</code><emclass="property"> = GuestOS(string='WIN_2000_ADV_SERV')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_2000_PRO</code><emclass="property"> = GuestOS(string='WIN_2000_PRO')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_2000_SERV</code><emclass="property"> = GuestOS(string='WIN_2000_SERV')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_31</code><emclass="property"> = GuestOS(string='WIN_31')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_31"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_95</code><emclass="property"> = GuestOS(string='WIN_95')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_95"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_98</code><emclass="property"> = GuestOS(string='WIN_98')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_98"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_LONGHORN</code><emclass="property"> = GuestOS(string='WIN_LONGHORN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_LONGHORN_64</code><emclass="property"> = GuestOS(string='WIN_LONGHORN_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_ME</code><emclass="property"> = GuestOS(string='WIN_ME')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_ME"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_NET_BUSINESS</code><emclass="property"> = GuestOS(string='WIN_NET_BUSINESS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_NET_DATACENTER</code><emclass="property"> = GuestOS(string='WIN_NET_DATACENTER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Datacenter Edition</p>
<codeclass="descname">WIN_NET_DATACENTER_64</code><emclass="property"> = GuestOS(string='WIN_NET_DATACENTER_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Datacenter Edition (64 bit) (experimental)</p>
<codeclass="descname">WIN_NET_ENTERPRISE</code><emclass="property"> = GuestOS(string='WIN_NET_ENTERPRISE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Enterprise Edition</p>
<codeclass="descname">WIN_NET_ENTERPRISE_64</code><emclass="property"> = GuestOS(string='WIN_NET_ENTERPRISE_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Enterprise Edition (64 bit)</p>
<codeclass="descname">WIN_NET_STANDARD</code><emclass="property"> = GuestOS(string='WIN_NET_STANDARD')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_NET_STANDARD_64</code><emclass="property"> = GuestOS(string='WIN_NET_STANDARD_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Standard Edition (64 bit)</p>
<codeclass="descname">WIN_NET_WEB</code><emclass="property"> = GuestOS(string='WIN_NET_WEB')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_NT</code><emclass="property"> = GuestOS(string='WIN_NT')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_VISTA</code><emclass="property"> = GuestOS(string='WIN_VISTA')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_VISTA_64</code><emclass="property"> = GuestOS(string='WIN_VISTA_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_XP_HOME</code><emclass="property"> = GuestOS(string='WIN_XP_HOME')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_XP_PRO</code><emclass="property"> = GuestOS(string='WIN_XP_PRO')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WIN_XP_PRO_64</code><emclass="property"> = GuestOS(string='WIN_XP_PRO_64')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows XP Professional Edition (64 bit)</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">GuestOSFamily</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DARWIN</code><emclass="property"> = GuestOSFamily(string='DARWIN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">LINUX</code><emclass="property"> = GuestOSFamily(string='LINUX')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWARE</code><emclass="property"> = GuestOSFamily(string='NETWARE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OTHER</code><emclass="property"> = GuestOSFamily(string='OTHER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.OTHER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SOLARIS</code><emclass="property"> = GuestOSFamily(string='SOLARIS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WINDOWS</code><emclass="property"> = GuestOSFamily(string='WINDOWS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">Hardware</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>version=None</em>, <em>upgrade_policy=None</em>, <em>upgrade_version=None</em>, <em>upgrade_status=None</em>, <em>upgrade_error=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>upgrade_version</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.Version"title="com.vmware.vcenter.vm_client.Hardware.Version"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.Version</span></code></a>) – Target hardware version to be used on the next scheduled virtual
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>upgrade_policy=None</em>, <em>upgrade_version=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>If set to <aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.Info.upgrade_version</span></code> attribute will be reset to
<li><p><strong>upgrade_version</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.Version"title="com.vmware.vcenter.vm_client.Hardware.Version"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.Version</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Target hardware version to be used on the next scheduled virtual
<p>If specified, this attribute must represent a newer virtual
hardware version than the current virtual hardware version reported
in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.Info.version</span></code>.
If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpdateSpec.upgrade_policy</span></code> is set to
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, this attribute must be None.
Otherwise, if this attribute is None, default to the most recent
virtual hardware version supported by the server.</p>
<emclass="property">class </em><codeclass="descname">UpgradePolicy</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">AFTER_CLEAN_SHUTDOWN</code><emclass="property"> = UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on after a clean
<codeclass="descname">ALWAYS</code><emclass="property"> = UpgradePolicy(string='ALWAYS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS"title="Permalink to this definition">¶</a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on.</p>
<codeclass="descname">NEVER</code><emclass="property"> = UpgradePolicy(string='NEVER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="Permalink to this definition">¶</a></dt>
<dd><p>Do not upgrade the virtual machine when it is powered on.</p>
<emclass="property">class </em><codeclass="descname">UpgradeStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">FAILED</code><emclass="property"> = UpgradeStatus(string='FAILED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The most recent scheduled upgrade was not successful.</p>
<codeclass="descname">NONE</code><emclass="property"> = UpgradeStatus(string='NONE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No scheduled upgrade has been attempted.</p>
<codeclass="descname">PENDING</code><emclass="property"> = UpgradeStatus(string='PENDING')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.PENDING"title="Permalink to this definition">¶</a></dt>
<dd><p>Upgrade is scheduled but has not yet been run.</p>
<codeclass="descname">SUCCESS</code><emclass="property"> = UpgradeStatus(string='SUCCESS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.SUCCESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The most recent scheduled upgrade was successful.</p>
<emclass="property">class </em><codeclass="descname">Version</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version"title="Permalink to this definition">¶</a></dt>
for a virtual machine. See <aclass="reference external"href="https://kb.vmware.com/s/article/1003746">https://kb.vmware.com/s/article/1003746</a> (Virtual
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">VMX_03</code><emclass="property"> = Version(string='VMX_03')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_03"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_04</code><emclass="property"> = Version(string='VMX_04')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_04"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_06</code><emclass="property"> = Version(string='VMX_06')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_06"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_07</code><emclass="property"> = Version(string='VMX_07')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_07"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_08</code><emclass="property"> = Version(string='VMX_08')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_08"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_09</code><emclass="property"> = Version(string='VMX_09')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_09"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_10</code><emclass="property"> = Version(string='VMX_10')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_10"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_11</code><emclass="property"> = Version(string='VMX_11')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_11"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_12</code><emclass="property"> = Version(string='VMX_12')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_12"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_13</code><emclass="property"> = Version(string='VMX_13')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_13"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_14</code><emclass="property"> = Version(string='VMX_14')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_14"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMX_15</code><emclass="property"> = Version(string='VMX_15')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_15"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 15, first supported in ESXi 6.7.0 Update 2. This class
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the virtual hardware settings of a virtual machine.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the virtual hardware settings of a virtual machine.</p>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec"title="com.vmware.vcenter.vm_client.Hardware.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.UpdateSpec</span></code></a>) – Specification for updating the virtual hardware settings of the
<codeclass="descname">upgrade</code><spanclass="sig-paren">(</span><em>vm</em>, <em>version=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.upgrade"title="Permalink to this definition">¶</a></dt>
<dd><p>Upgrades the virtual machine to a newer virtual hardware version.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">Identity</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Identity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity</span></code> class provides methods for managing the identity of a
virtual machine. This class was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>bios_uuid=None</em>, <em>instance_uuid=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Identity.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity.Info</span></code> class contains information about the identity of a
virtual machine. This class was added in vSphere API 6.7.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Virtual machine name. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 128-bit SMBIOS UUID of a virtual machine represented as a
hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
format. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>instance_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – VirtualCenter-specific 128-bit UUID of a virtual machine,
represented as a hexademical string. This identifier is used by
VirtualCenter to uniquely identify all virtual machine instances,
including those that may share the same SMBIOS UUID. This attribute
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">Power</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>clean_power_off=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Power.State"title="com.vmware.vcenter.vm_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
<li><p><strong>clean_power_off</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual machine was powered off
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">POWERED_OFF</code><emclass="property"> = State(string='POWERED_OFF')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">POWERED_ON</code><emclass="property"> = State(string='POWERED_ON')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.POWERED_ON"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SUSPENDED</code><emclass="property"> = State(string='SUSPENDED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.SUSPENDED"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual machine is suspended.</p>
</dd></dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter.vm_client.Power.get">
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the power state information of a virtual machine.</p>
<codeclass="descname">reset</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.reset"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Powers on a powered-off or suspended virtual machine.</p>
<codeclass="descname">stop</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.stop"title="Permalink to this definition">¶</a></dt>
<dd><p>Powers off a powered-on or suspended virtual machine.</p>
<codeclass="descname">suspend</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.suspend"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-template-client-module"></span><h2>com.vmware.vcenter.vm_template_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm_template_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_template_client</span></code> module provides classes and
classes that will let its client manage VMTX template in Content Library.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_template_client.</code><codeclass="descname">LibraryItems</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">CpuInfo</code><spanclass="sig-paren">(</span><em>count=None</em>, <em>cores_per_socket=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores per socket. This attribute was added in vSphere
<emclass="property">class </em><codeclass="descname">CpuUpdateSpec</code><spanclass="sig-paren">(</span><em>num_cpus=None</em>, <em>num_cores_per_socket=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>num_cpus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of virtual processors in the deployed virtual machine. This
<li><p><strong>num_cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of cores among which to distribute CPUs in the deployed
virtual machine. This attribute was added in vSphere API 6.8.
<emclass="property">class </em><codeclass="descname">CreatePlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the virtual machine template should be
placed. This attribute was added in vSphere API 6.8.
chosen, the library item creation operation will fail.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host onto which the virtual machine template should be placed. If
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code>
must belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both
specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine template; if a host cannot be chosen,
the library item creation operation will fail.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster onto which the virtual machine template should be placed.
If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<li><p><strong>source_vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the source virtual machine to create the library item
from. This attribute was added in vSphere API 6.8.
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the library item. This attribute was added in vSphere API
6.8.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the library item. This attribute was added in
<li><p><strong>library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library in which the new library item should be
created. This attribute was added in vSphere API 6.8.
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
virtual machine template’s disks are placed in the default storage
backing associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the virtual machine template’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
virtual machine template’s disks are placed in the default storage
backing associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the virtual machine template’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreatePlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Information used to place the virtual machine template. This
<emclass="property">class </em><codeclass="descname">CreateSpecDiskStorage</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier for the datastore associated with a virtual machine
template’s disk. This attribute was added in vSphere API 6.8.
This attribute is currently required. If None, <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code>
must be set. The server picks a datastore that is compatible with
the specified storage policy.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code> are specified, and the
storage policy is incompatible with the <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code>, then the
disk will be flagged as being out of compliance with the specified
<emclass="property">class </em><codeclass="descname">CreateSpecDiskStoragePolicy</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStoragePolicy.Type</span></code></a>) – Policy type to be used when creating a virtual machine template’s
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = Type(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">CreateSpecVmHomeStorage</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the datastore for the virtual machine template’s
This attribute is currently required. If None, <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code>
must be set. The server picks a datastore that is compatible with
the specified storage policy.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code> are specified, and the
storage policy is incompatible with the <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code>, then the
virtual machine template will be flagged as being out of compliance
<emclass="property">class </em><codeclass="descname">CreateSpecVmHomeStoragePolicy</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the virtual machine template’s
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = Type(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">DeployPlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Virtual machine folder into which the deployed virtual machine
should be placed. This attribute was added in vSphere API 6.8.
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the deployed virtual machine should be
placed. This attribute was added in vSphere API 6.8.
virtual machine deployment operation will fail.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host onto which the virtual machine should be placed. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>
and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must
belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute was added
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
virtual machine deployment operation will fail.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster onto which the deployed virtual machine should be placed.
If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the deployed virtual machine. This attribute was added in
vSphere API 6.8.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the deployed virtual machine. This attribute was
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
deployed virtual machine’s disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the deployed virtual machine’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
deployed virtual machine’s disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the deployed virtual machine’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeployPlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Information used to place the deployed virtual machine. This
<li><p><strong>powered_on</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether the deployed virtual machine should be powered on
after deployment. This attribute was added in vSphere API 6.8.
<emclass="property">class </em><codeclass="descname">DeploySpecDiskStorage</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier for the datastore associated the deployed virtual
machine’s disk. This attribute was added in vSphere API 6.8.
This attribute is currently required. If None, <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code>
must be set. The server picks a datastore that is compatible with
the specified storage policy.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code> are specified, and the
storage policy is incompatible with the <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code>, then the
disk will be flagged as being out of compliance with the specified
<emclass="property">class </em><codeclass="descname">DeploySpecDiskStoragePolicy</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecDiskStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the deployed virtual machine’s
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy to use. This attribute was added
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">USE_SOURCE_POLICY</code><emclass="property"> = Type(string='USE_SOURCE_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SOURCE_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the storage policy that is associated with the corresponding disk in
the source virtual machine template. This class attribute was added in
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = Type(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">DeploySpecVmHomeStorage</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the datastore for the deployed virtual machine’s
This attribute is currently required. If None, <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code>
must be set. The server picks a datastore that is compatible with
the specified storage policy.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">storagePolicy</span></code> are specified, and the
storage policy is incompatible with the <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code>, then the
deployed virtual machine will be flagged as being out of compliance
<emclass="property">class </em><codeclass="descname">DeploySpecVmHomeStoragePolicy</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the deployed virtual machine’s
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">USE_SOURCE_POLICY</code><emclass="property"> = Type(string='USE_SOURCE_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SOURCE_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the storage policy that is associated with the source virtual machine
template’s configuration and log files. This class attribute was added in
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = Type(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">DiskInfo</code><spanclass="sig-paren">(</span><em>capacity=None</em>, <em>disk_storage=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Capacity of the virtual disk in bytes. This attribute was added in
vSphere API 6.8.
This attribute will be None if the virtual disk is inaccessible.</p></li>
<li><p><strong>disk_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DiskStorageInfo</span></code></a>) – Disk storage related information. This attribute was added in
<emclass="property">class </em><codeclass="descname">DiskStorageInfo</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore where the disk is stored. This
<li><p><strong>storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the storage policy associated with the virtual disk.
<emclass="property">class </em><codeclass="descname">DiskUpdateSpec</code><spanclass="sig-paren">(</span><em>capacity=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Updated capacity of the virtual disk backing in bytes. This value
<emclass="property">class </em><codeclass="descname">EthernetInfo</code><spanclass="sig-paren">(</span><em>backing_type=None</em>, <em>mac_type=None</em>, <em>network=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>backing_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code></a>) – Network backing type for the virtual Ethernet adapter. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>mac_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.MacAddressType</span></code></a>) – MAC address type of the ethernet adapter. This attribute was added
in vSphere API 6.8.</p></li>
<li><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the network backing the virtual Ethernet adapter.
<emclass="property">class </em><codeclass="descname">MacAddressType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ASSIGNED</code><emclass="property"> = MacAddressType(string='ASSIGNED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.ASSIGNED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned by vCenter Server. This class attribute was added
<codeclass="descname">GENERATED</code><emclass="property"> = MacAddressType(string='GENERATED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.GENERATED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is generated automatically. This class attribute was added in
<codeclass="descname">MANUAL</code><emclass="property"> = MacAddressType(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned statically. This class attribute was added in
<emclass="property">class </em><codeclass="descname">NetworkBackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DISTRIBUTED_PORTGROUP</code><emclass="property"> = NetworkBackingType(string='DISTRIBUTED_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>Distributed virtual switch backing. This class attribute was added in
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = NetworkBackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Legacy host device network backing. Imported VMs may have virtual Ethernet
adapters with this type of backing, but this type of backing cannot be used
to create or to update a virtual Ethernet adapter. This class attribute was
<codeclass="descname">OPAQUE_NETWORK</code><emclass="property"> = NetworkBackingType(string='OPAQUE_NETWORK')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STANDARD_PORTGROUP</code><emclass="property"> = NetworkBackingType(string='STANDARD_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network backing. This class attribute was added
<emclass="property">class </em><codeclass="descname">EthernetUpdateSpec</code><spanclass="sig-paren">(</span><em>network=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the network backing the virtual Ethernet adapter.
<emclass="property">class </em><codeclass="descname">GuestCustomizationSpec</code><spanclass="sig-paren">(</span><em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the customization specification. This attribute was added
<emclass="property">class </em><codeclass="descname">HardwareCustomizationSpec</code><spanclass="sig-paren">(</span><em>nics=None</em>, <em>disks_to_remove=None</em>, <em>disks_to_update=None</em>, <em>cpu_update=None</em>, <em>memory_update=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>disks_to_remove</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Idenfiers of disks to remove from the deployed virtual machine.
<li><p><strong>cpu_update</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CpuUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CPU update specification for the deployed virtual machine. This
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>guest_os</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.GuestOS"title="com.vmware.vcenter.vm_client.GuestOS"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Configured guest operating system of the virtual machine template.
This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cpu</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CpuInfo</span></code></a>) – CPU configuration of the virtual machine template. This attribute
was added in vSphere API 6.8.</p></li>
<li><p><strong>memory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.MemoryInfo</span></code></a>) – Memory configuration of the virtual machine template. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>vm_home_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.VmHomeStorageInfo</span></code></a>) – Storage information about the virtual machine template’s
<li><p><strong>vm_template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the latest virtual machine template contained in the
library item. This attribute is the managed object identifier used
to identify the virtual machine template in the vSphere Management
(SOAP) API. This attribute was added in vSphere API 6.8.</p></li>
<emclass="property">class </em><codeclass="descname">MemoryInfo</code><spanclass="sig-paren">(</span><em>size_mib=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>size_mib</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Memory size in mebibytes. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">MemoryUpdateSpec</code><spanclass="sig-paren">(</span><em>memory=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>memory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Size of a virtual machine’s memory in MB. This attribute was added
<emclass="property">class </em><codeclass="descname">VmHomeStorageInfo</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore where the virtual machine template’s
<li><p><strong>storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the storage policy associated with the virtual
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a library item in content library from a virtual machine. This
method creates a library item in content library whose content is a
virtual machine template created from the source virtual machine, using
the supplied create specification. The virtual machine template is
stored in a newly created library item. This method was added in
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpec</span></code></a>) – information used to create the library item from the source virtual
<codeclass="descname">deploy</code><spanclass="sig-paren">(</span><em>template_library_item</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.deploy"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys a virtual machine as a copy of the source virtual machine
template contained in the library item specified by
<codeclass="docutils literal notranslate"><spanclass="pre">template_library_item</span></code>. It uses the deployment specification in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpec.guest_customization</span></code> are specified, the
server triggers the power on and/or guest customization operations,
which are executed asynchronously. This method was added in vSphere API
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpec</span></code></a>) – specification of how the virtual machine should be deployed.</p></li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>template_library_item</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual machine template contained in the
library item specified by <codeclass="docutils literal notranslate"><spanclass="pre">template_library_item</span></code>. This method was
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm_template_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
