mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
13340 lines
1.1 MiB
13340 lines
1.1 MiB
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vcenter package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vcenter.certificate_management package" href="com.vmware.vcenter.certificate_management.html" />
|
||
<link rel="prev" title="com.vmware.vapi.std package" href="com.vmware.vapi.std.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
6.9.1
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li>com.vmware.vcenter package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vcenter.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-com.vmware.vcenter">
|
||
<span id="com-vmware-vcenter-package"></span><h1>com.vmware.vcenter package<a class="headerlink" href="#module-com.vmware.vcenter" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute.policies_client">com.vmware.vcenter.compute.policies_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.deployment.html">com.vmware.vcenter.deployment package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html">com.vmware.vcenter.deployment.install package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client">com.vmware.vcenter.deployment.install_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.hvc.html">com.vmware.vcenter.hvc package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.links_client">com.vmware.vcenter.hvc.links_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client">com.vmware.vcenter.hvc.management_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.storage.html">com.vmware.vcenter.storage package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html">com.vmware.vcenter.storage.policies package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.compute_client">com.vmware.vcenter.vm.compute_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client">com.vmware.vcenter.vm.guest_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.certificate_management_client">
|
||
<span id="com-vmware-vcenter-certificate-management-client-module"></span><h2>com.vmware.vcenter.certificate_management_client module<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client</span></code> module provides
|
||
classes to manage certificates.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.certificate_management_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.certificate_management_client.X509CertChain">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management_client.</code><code class="sig-name descname">X509CertChain</code><span class="sig-paren">(</span><em class="sig-param">cert_chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management_client.X509CertChain" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
|
||
added in vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cert_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate chain in base64 format. This attribute was added in
|
||
vSphere API 6.7.2.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.compute_client">
|
||
<span id="com-vmware-vcenter-compute-client-module"></span><h2>com.vmware.vcenter.compute_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client</span></code> module provides classes for managing
|
||
compute policies.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute_client.</code><code class="sig-name descname">Policies</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies</span></code> class provides methods to manage compute policies. A
|
||
compute policy defines the intended behavior for a collection of vSphere
|
||
objects identified by a tag. A compute policy is an instance of a
|
||
capability. It is created by providing a value for the creation type
|
||
specified by the capability. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type</span></code>.
|
||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||
changed in a future release.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.compute.Policy'</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">policy=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.Summary</span></code> class contains commonly used information about a
|
||
compute policy. <strong>Warning:</strong> This class is available as technical preview.
|
||
It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy. <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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Specification for the new policy to be created. The new policy will
|
||
be an instance of the capability that has the creation type (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type</span></code>)
|
||
equal to the type of the specified value (see <code class="docutils literal notranslate"><span class="pre">spec</span></code>).
|
||
The parameter must contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.CreateSpec" title="com.vmware.vcenter.compute.policies_client.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.CreateSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the newly created policy. Use this identifier to
|
||
get or destroy the policy.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if a policy with the same name is already present on this vCenter
|
||
server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if a parameter passed in the spec is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if more than 100 policies are created.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ComputePolicy.Manage</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.delete">
|
||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">policy</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy to be deleted.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a policy with this identifier does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ComputePolicy.Manage</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">policy</em><span class="sig-paren">)</span><a class="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
|
||
release.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy for which information should be retrieved.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Detailed information about the specified compute policy. The
|
||
returned value can be converted to the information type of the
|
||
capability that this policy is based on. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.info_type</span></code>.
|
||
The return value will contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.Info" title="com.vmware.vcenter.compute.policies_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Info</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a policy with this identifier does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.compute_client.Policies.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.compute_client.Policies.list" title="com.vmware.vcenter.compute_client.Policies.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute_client.Policies.Summary" title="com.vmware.vcenter.compute_client.Policies.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of compute policies available on this vCenter server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.compute_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.datastore_client">
|
||
<span id="com-vmware-vcenter-datastore-client-module"></span><h2>com.vmware.vcenter.datastore_client module<a class="headerlink" href="#module-com.vmware.vcenter.datastore_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.datastore_client.DefaultPolicy">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.datastore_client.</code><code class="sig-name descname">DefaultPolicy</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.datastore_client.DefaultPolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DefaultPolicy</span></code> class provides methods related to storage policies
|
||
associated with datastore object. The <a class="reference internal" href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get" title="com.vmware.vcenter.datastore_client.DefaultPolicy.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">DefaultPolicy.get()</span></code></a> method
|
||
provides information about the default storage policy associated with the
|
||
specific datastore. This class was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.datastore_client.DefaultPolicy.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">datastore</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datastore for which the default policy is
|
||
requested.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Identifier of the default storage policy associated with the
|
||
specified datastore.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
||
this field is None if there is no default storage policy associated
|
||
with the datastore.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the specified datastore does not exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user does not have the required priveleges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.datastore_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.datastore_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.datastore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.deployment_client">
|
||
<span id="com-vmware-vcenter-deployment-client-module"></span><h2>com.vmware.vcenter.deployment_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">ApplianceState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceState</span></code> class defines the various states the vCenter
|
||
Appliance can be in. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceState" title="com.vmware.vcenter.deployment_client.ApplianceState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceState</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.CONFIGURED">
|
||
<code class="sig-name descname">CONFIGURED</code><em class="property"> = ApplianceState(string='CONFIGURED')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.CONFIG_IN_PROGRESS">
|
||
<code class="sig-name descname">CONFIG_IN_PROGRESS</code><em class="property"> = ApplianceState(string='CONFIG_IN_PROGRESS')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.FAILED">
|
||
<code class="sig-name descname">FAILED</code><em class="property"> = ApplianceState(string='FAILED')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.INITIALIZED">
|
||
<code class="sig-name descname">INITIALIZED</code><em class="property"> = ApplianceState(string='INITIALIZED')</em><a class="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
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.NOT_INITIALIZED">
|
||
<code class="sig-name descname">NOT_INITIALIZED</code><em class="property"> = ApplianceState(string='NOT_INITIALIZED')</em><a class="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
|
||
configuration. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.QUESTION_RAISED">
|
||
<code class="sig-name descname">QUESTION_RAISED</code><em class="property"> = ApplianceState(string='QUESTION_RAISED')</em><a class="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
|
||
in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceType">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">ApplianceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceType</span></code> class defines the vCenter appliance types. This
|
||
enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceType</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.PSC_EXTERNAL">
|
||
<code class="sig-name descname">PSC_EXTERNAL</code><em class="property"> = ApplianceType(string='PSC_EXTERNAL')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EMBEDDED">
|
||
<code class="sig-name descname">VCSA_EMBEDDED</code><em class="property"> = ApplianceType(string='VCSA_EMBEDDED')</em><a class="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.
|
||
This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EXTERNAL">
|
||
<code class="sig-name descname">VCSA_EXTERNAL</code><em class="property"> = ApplianceType(string='VCSA_EXTERNAL')</em><a class="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.
|
||
This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.CheckInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">CheckInfo</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CheckInfo</span></code> class describes the result of the appliance deployment
|
||
check. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="com.vmware.vcenter.deployment_client.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notifications" title="com.vmware.vcenter.deployment_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Result of the check. This attribute was added in vSphere API 6.7.
|
||
This attribute will be None if result is not available at the
|
||
current step of the task.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.CheckStatus">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">CheckStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CheckStatus</span></code> class defines the status of the checks. This
|
||
enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="com.vmware.vcenter.deployment_client.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckStatus</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.CheckStatus.FAILED">
|
||
<code class="sig-name descname">FAILED</code><em class="property"> = CheckStatus(string='FAILED')</em><a class="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
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.CheckStatus.SUCCESS">
|
||
<code class="sig-name descname">SUCCESS</code><em class="property"> = CheckStatus(string='SUCCESS')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">HistoryMigrationOption</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">HistoryMigrationOption</span></code> class defines the vCenter history migration
|
||
option choices. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationOption</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption.ALL">
|
||
<code class="sig-name descname">ALL</code><em class="property"> = HistoryMigrationOption(string='ALL')</em><a class="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
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption.EVENTS_TASKS">
|
||
<code class="sig-name descname">EVENTS_TASKS</code><em class="property"> = HistoryMigrationOption(string='EVENTS_TASKS')</em><a class="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.
|
||
This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">HistoryMigrationSpec</code><span class="sig-paren">(</span><em class="sig-param">data_set=None</em>, <em class="sig-param">defer_import=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">HistoryMigrationSpec</span></code> class defines how vCenter history data will be
|
||
migrated. vCenter History data includes</p>
|
||
<ul class="simple">
|
||
<li><p>Statistics</p></li>
|
||
<li><p>Events</p></li>
|
||
<li><p>Tasks</p></li>
|
||
</ul>
|
||
<p>. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>data_set</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defines how vCenter history will be migrated. If set to true,
|
||
vCenter history will be migrated separately after successful
|
||
upgrade or migration, otherwise it will be migrated along with core
|
||
data during the upgrade or migration process. This attribute was
|
||
added in vSphere API 6.7.
|
||
If None, vCenter historical data won’t be deferred and will be
|
||
migrated along with core data.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">ImportHistory</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory</span></code> class provides methods for managing the import of
|
||
vCenter historical data, e.g. Tasks, Events and Statistics, when is is
|
||
imported separately from the upgrade or migration process. This class was
|
||
added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code> class contains information to create and
|
||
start vCenter historical data lazy-import. This class was added in vSphere
|
||
API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter history import task. This attribute was added
|
||
in vSphere API 6.7.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the vCenter history import task. This attribute was
|
||
added in vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory.Info</span></code> class contains attributes to describe the state
|
||
of vCenter history import task. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this task. This attribute was added in vSphere
|
||
API 6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>.</p></li>
|
||
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notifications" title="com.vmware.vcenter.deployment_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Result of the operation. If an operation reports partial results
|
||
before it completes, this attribute could be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> before
|
||
the null has the value
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. The value
|
||
could change as the operation progresses. This attribute was added
|
||
in vSphere API 6.7.
|
||
This attribute will be None if result is not available at the
|
||
current step of the operation.</p></li>
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||
as a return value, the attribute will be an identifier for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||
This attribute will be None if the task has no parent.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||
one the operation performed on.
|
||
This attribute will be None if the operation has no target or
|
||
multiple targets.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||
value may change as the operation progresses.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||
If None the description of why the operation failed will be
|
||
included in the result of the operation (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
||
This attribute will be None if the operation is performed by the
|
||
system.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.cancel">
|
||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the caller is not authorized to perform the method.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if vCenter historical data import task cannot be canceled at this
|
||
state. This can happen in the following cases:</p>
|
||
<ul class="simple">
|
||
<li><p>If historical data import has not been started yet because a not
|
||
running task cannot be canceled</p></li>
|
||
<li><p>If historical data import has already been completed because a
|
||
completed task cannot be canceled</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if vCenter historical data import task is already canceled.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
Generic error.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
method was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.ImportHistory.Info" title="com.vmware.vcenter.deployment_client.ImportHistory.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportHistory.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Info structure containing the status information about the
|
||
historical data import status.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the caller is not authorized to perform the method.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
Generic error</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.pause">
|
||
<code class="sig-name descname">pause</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the caller is not authorized to perform the method.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if vCenter historical data import task cannot be paused at this
|
||
time. Pause can be accepted only in
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a> state.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if vCenter historical data import task is already paused</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
Generic error</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.resume">
|
||
<code class="sig-name descname">resume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the caller is not authorized to perform the method.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if vCenter historical data import task cannot be resumed at this
|
||
state. Resume can be accepted only in
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a> state</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if vCenter historical data import task is already resumed.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
Generic error.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.start">
|
||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="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
|
||
method was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec" title="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>An optional <code class="docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code> info that can be passed
|
||
for creating a new historical data import task and starts it.
|
||
If None, default value will be:</p>
|
||
<ul class="simple">
|
||
<li><p>name : vcenter.deployment.history.import</p></li>
|
||
<li><p>description : vCenter Server history import</p></li>
|
||
</ul>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the caller is not authorized to perform the method.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if vCenter historical data import task cannot be started at this
|
||
time. This can happen in the following cases:</p>
|
||
<ul class="simple">
|
||
<li><p>If historical data import has already been canceled because a
|
||
canceled task cannot be re-started</p></li>
|
||
<li><p>If historical data import has already been completed because a
|
||
completed task cannot be re-started</p></li>
|
||
<li><p>If historical data import has already been paused because a
|
||
paused task can only be resumed or canceled</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if vCenter historical data import task has already being started.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
Generic error</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Install</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Install</span></code> class provides methods to configure the installation of the
|
||
appliance. This class was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.InstallSpec">
|
||
<em class="property">class </em><code class="sig-name descname">InstallSpec</code><span class="sig-paren">(</span><em class="sig-param">vcsa_embedded=None</em>, <em class="sig-param">auto_answer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code> class contains information used to configure
|
||
the appliance installation. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vcsa_embedded</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec" title="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.VcsaEmbeddedSpec</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 was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>auto_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Use the default option for any questions that may come up during
|
||
appliance configuration. This attribute was added in vSphere API
|
||
6.7.
|
||
If None, will default to false.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec">
|
||
<em class="property">class </em><code class="sig-name descname">VcsaEmbeddedSpec</code><span class="sig-paren">(</span><em class="sig-param">standalone=None</em>, <em class="sig-param">replicated=None</em>, <em class="sig-param">ceip_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Install.VcsaEmbeddedSpec</span></code> class contains information used to
|
||
configure an embedded standalone or replicated vCenter Server. This class
|
||
was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>standalone</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.StandaloneSpec" title="com.vmware.vcenter.deployment_client.StandaloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">StandaloneSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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. This attribute was added in vSphere API 6.7.
|
||
If None, will default to None.</p></li>
|
||
<li><p><strong>replicated</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ReplicatedSpec" title="com.vmware.vcenter.deployment_client.ReplicatedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicatedSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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. This attribute was added in vSphere API 6.7.
|
||
If None, will default to None.</p></li>
|
||
<li><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether CEIP should be enabled or disabled. This attribute was
|
||
added in vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.cancel">
|
||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in CONFIG_IN_PROGRESS state and if the
|
||
operation is not INSTALL.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.check">
|
||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a>) – InstallSpec parameters to run sanity check with.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>CheckInfo containing the check results.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if external PSC credentials are not valid when configuring PSC to
|
||
replicate with an external existing PSC.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if external PSC credentials are not valid when configuring a
|
||
VCSA_EXTERNAL appliance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in INITIALIZED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
installation. This method was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>InstallSpec parameters being used to configure appliance install.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if appliance is not in INSTALL_PROGRESS state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Install.start">
|
||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a>) – InstallSpec parameters to configure the appliance install.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the partner PSC credentials are not valid when configuring PSC
|
||
to replicate with partner PSC.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if external PSC credentials are not valid when configuring a
|
||
VCSA_EXTERNAL appliance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in INITIALIZED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.LocationSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">LocationSpec</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.LocationSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LocationSpec</span></code> class is used to pass the container ESXi or vCenter
|
||
server of the VM to patch the size of this appliance. This class was added
|
||
in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the container. This
|
||
attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
|
||
verification. This attribute was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is
|
||
true and and <code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is None, the CA certificate will be
|
||
used for verification. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and
|
||
<code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
|
||
verification. No verification will be performed if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code>
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The administrator account password. This attribute was added in
|
||
vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Notification">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Notification</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">time=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">resolution=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Notification" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Notification</span></code> class contains attributes to describe any
|
||
info/warning/error messages that Tasks can raise. This class was added in
|
||
vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification id. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The time the notification was raised/found. This attribute was
|
||
added in vSphere API 6.7.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the time information is available.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. This attribute was added in vSphere API
|
||
6.7.</p></li>
|
||
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any. This attribute was added in vSphere
|
||
API 6.7.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Notifications">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Notifications</code><span class="sig-paren">(</span><em class="sig-param">info=None</em>, <em class="sig-param">warnings=None</em>, <em class="sig-param">errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Notifications" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Notifications</span></code> class contains info/warning/error messages that can
|
||
be reported be the task. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported. This attribute was added in
|
||
vSphere API 6.7.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
|
||
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported. This attribute was added in
|
||
vSphere API 6.7.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
|
||
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported. This attribute was added in
|
||
vSphere API 6.7.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Operation</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class defines the supported vCenter appliance deployment
|
||
operations. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Operation" title="com.vmware.vcenter.deployment_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operation</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation.INSTALL">
|
||
<code class="sig-name descname">INSTALL</code><em class="property"> = Operation(string='INSTALL')</em><a class="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
|
||
in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation.MIGRATE">
|
||
<code class="sig-name descname">MIGRATE</code><em class="property"> = Operation(string='MIGRATE')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation.RESTORE">
|
||
<code class="sig-name descname">RESTORE</code><em class="property"> = Operation(string='RESTORE')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation.ROLLBACK">
|
||
<code class="sig-name descname">ROLLBACK</code><em class="property"> = Operation(string='ROLLBACK')</em><a class="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
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Operation.UPGRADE">
|
||
<code class="sig-name descname">UPGRADE</code><em class="property"> = Operation(string='UPGRADE')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Question</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Question</span></code> class provides methods to get the question raised during
|
||
deployment and to answer them. This class was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.AnswerSpec">
|
||
<em class="property">class </em><code class="sig-name descname">AnswerSpec</code><span class="sig-paren">(</span><em class="sig-param">question_id=None</em>, <em class="sig-param">answer_val=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Question.AnswerSpec</span></code> class contains attributes to describe the
|
||
answer to a raised question. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>question_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The answer value. This attribute was added in vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">questions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Question.Info</span></code> class contains attributes to describe questions
|
||
raised during the deployment process. This class was added in vSphere API
|
||
6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>questions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.Question" title="com.vmware.vcenter.deployment_client.Question.Question"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.Question</span></code></a>) – One or more questions raised during the deployment. This attribute
|
||
was added in vSphere API 6.7.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.Question">
|
||
<em class="property">class </em><code class="sig-name descname">Question</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">question=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">default_answer=None</em>, <em class="sig-param">possible_answers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.Question" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Question.Question</span></code> class contains attributes to describe a
|
||
deployment question. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message describing the question. This attribute was added in
|
||
vSphere API 6.7.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.QuestionType" title="com.vmware.vcenter.deployment_client.Question.QuestionType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Default answer value. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>possible_answers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Possible answers values. This attribute was added in vSphere API
|
||
6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType">
|
||
<em class="property">class </em><code class="sig-name descname">QuestionType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.QuestionType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Question.QuestionType</span></code> class defines the type of the question
|
||
raised. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">QuestionType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.ABORT_RETRY_IGNORE">
|
||
<code class="sig-name descname">ABORT_RETRY_IGNORE</code><em class="property"> = QuestionType(string='ABORT_RETRY_IGNORE')</em><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.OK_CANCEL">
|
||
<code class="sig-name descname">OK_CANCEL</code><em class="property"> = QuestionType(string='OK_CANCEL')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.YES_NO">
|
||
<code class="sig-name descname">YES_NO</code><em class="property"> = QuestionType(string='YES_NO')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.answer">
|
||
<code class="sig-name descname">answer</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec" title="com.vmware.vcenter.deployment_client.Question.AnswerSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.AnswerSpec</span></code></a>) – AnswerSpec with the answer to the raised question.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is NOT in QUESTION_RAISED state.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
|
||
if answer file could not be created.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Question.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.Info" title="com.vmware.vcenter.deployment_client.Question.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Info structure containing the question.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in QUESTION_RAISED state.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
|
||
if questions could not be retrieved although the appliance is in
|
||
QUESTION_RAISED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.RemotePscSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">RemotePscSpec</code><span class="sig-paren">(</span><em class="sig-param">psc_hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">RemotePscSpec</span></code> class contains information used to configure an
|
||
external vCenter Server that registers with a remote PSC. This class was
|
||
added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>psc_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC to which
|
||
this configuring vCenter Server will be registered to. This
|
||
attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
|
||
verification when ssl_verify field is set to true. This attribute
|
||
was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is
|
||
true and and <code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is None, the CA certificate will be
|
||
used for verification. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and
|
||
<code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
|
||
verification. No verification will be performed if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code>
|
||
value is set to false. This attribute was added in vSphere API 6.7.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> true will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ReplicatedPscSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">ReplicatedPscSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_site_name=None</em>, <em class="sig-param">partner_hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ReplicatedPscSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicatedPscSpec</span></code> class contains information used to check if the
|
||
configuring PSC can be replicated to the remote PSC. This class was added
|
||
in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso_site_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
|
||
verification. This attribute was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
|
||
added in vSphere API 6.7.
|
||
If None, ssl_verify true will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.ReplicatedSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">ReplicatedSpec</code><span class="sig-paren">(</span><em class="sig-param">partner_hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ReplicatedSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicatedSpec</span></code> class contains information used to check if the
|
||
configuring vCenter Server can be replicated to the remote PSC. This class
|
||
was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>partner_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the partner PSC appliance.
|
||
This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
|
||
verification. This attribute was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
|
||
added in vSphere API 6.7.
|
||
If None, ssl_verify true will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.StandalonePscSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">StandalonePscSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_site_name=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">sso_domain_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StandalonePscSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">StandalonePscSpec</span></code> class contains information used to configure a
|
||
standalone PSC appliance. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso_site_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None, vsphere.local will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.StandaloneSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">StandaloneSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">sso_domain_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StandaloneSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">StandaloneSpec</span></code> class contains information used to configure a
|
||
standalone embedded vCenter Server appliance. This class was added in
|
||
vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None, vsphere.local will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">Upgrade</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade</span></code> class provides methods to configure the upgrade of this
|
||
appliance from an existing vCenter appliance. This class was added in
|
||
vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.PscSpec">
|
||
<em class="property">class </em><code class="sig-name descname">PscSpec</code><span class="sig-paren">(</span><em class="sig-param">ceip_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.PscSpec</span></code> class contains information used to upgrade a
|
||
Platform Service Controller appliance. This class was added in vSphere API
|
||
6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Customer experience improvement program should be enabled or
|
||
disabled for this Platform Services Controller upgrade. This
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec">
|
||
<em class="property">class </em><code class="sig-name descname">SourceApplianceSpec</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em>, <em class="sig-param">sso_admin_username=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">root_password=None</em>, <em class="sig-param">ssh_verify=None</em>, <em class="sig-param">ssh_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.SourceApplianceSpec</span></code> class contains information used to
|
||
connect to the appliance used as the source for an upgrade. This class was
|
||
added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the source appliance. This
|
||
attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
|
||
verification. This attribute was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled for the source
|
||
appliance validations. By default it is enabled and will use SSL
|
||
certificate for verification. If thumbprint is provided, will use
|
||
thumbprint for the verification. This attribute was added in
|
||
vSphere API 6.7.
|
||
If None, ssl_verify true will be used.</p></li>
|
||
<li><p><strong>sso_admin_username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Appliance SSH verification should be enabled or disabled. By
|
||
default it is disabled and will not use any verification. If
|
||
thumbprint is provided, thumbprint verification will be performed.
|
||
This attribute was added in vSphere API 6.7.
|
||
If None, ssh_verify true will be used.</p></li>
|
||
<li><p><strong>ssh_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – MD5 thumbprint of the server SSH key will be used for verification.
|
||
This attribute was added in vSphere API 6.7.
|
||
This attribute is only relevant if <code class="docutils literal notranslate"><span class="pre">sshVerify</span></code> is None or has the
|
||
value true.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpgradeSpec</code><span class="sig-paren">(</span><em class="sig-param">source_appliance=None</em>, <em class="sig-param">source_location=None</em>, <em class="sig-param">history=None</em>, <em class="sig-param">vcsa_embedded=None</em>, <em class="sig-param">psc=None</em>, <em class="sig-param">auto_answer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code> class contains information used to configure
|
||
the appliance upgrade. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source_appliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec" title="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.LocationSpec" title="com.vmware.vcenter.deployment_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocationSpec</span></code></a>) – Source location spec. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>history</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec" title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Determines how vCenter history will be migrated during the upgrade
|
||
process. vCenter history consists of:</p>
|
||
<ul>
|
||
<li><p>Statistics</p></li>
|
||
<li><p>Events</p></li>
|
||
<li><p>Tasks</p></li>
|
||
</ul>
|
||
<p>By default only core data will be migrated. Use this spec to define
|
||
which part of vCenter history data will be migrated and when. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None, only core database content will be migrated.</p>
|
||
</p></li>
|
||
<li><p><strong>vcsa_embedded</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec" title="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.VcsaEmbeddedSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information that are specific to this embedded vCenter Server. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None, ceip_enabled for embedded vcenter server upgrade will
|
||
default to enabled.</p></li>
|
||
<li><p><strong>psc</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec" title="com.vmware.vcenter.deployment_client.Upgrade.PscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.PscSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Use the default option for any questions that may come up during
|
||
appliance configuration. This attribute was added in vSphere API
|
||
6.7.
|
||
If None, will default to false.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec">
|
||
<em class="property">class </em><code class="sig-name descname">VcsaEmbeddedSpec</code><span class="sig-paren">(</span><em class="sig-param">ceip_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.VcsaEmbeddedSpec</span></code> class contains information used to upgrade
|
||
a Embedded vCenter Server appliance. This class was added in vSphere API
|
||
6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Customer experience improvement program should be enabled or
|
||
disabled for this embedded vCenter Server upgrade. This attribute
|
||
was added in vSphere API 6.7.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.cancel">
|
||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in CONFIG_IN_PROGRESS state and if the
|
||
operation is not INSTALL.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.check">
|
||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a>) – UpgradeSpec parameters to run sanity check on.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>CheckInfo containing the check results.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if source credentials are not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if source container credentials are not valid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in INITIALIZED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
upgrade. This method was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>UpgradeSpec parameters being used to configure appliance upgrade.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if appliance is not in UPGRADE_PROGRESS state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.deployment_client.Upgrade.start">
|
||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a>) – UpgradeSpec parameters to configure the appliance upgrade.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if source credentials are not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if source container credentials are not valid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in INITIALIZED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.deployment_client.VerificationMode">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment_client.</code><code class="sig-name descname">VerificationMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.VerificationMode" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">VerificationMode</span></code> class defines the verification modes for SSL
|
||
certificates or SSH connections. This enumeration was added in vSphere API
|
||
6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.VerificationMode" title="com.vmware.vcenter.deployment_client.VerificationMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">VerificationMode</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.VerificationMode.NONE">
|
||
<code class="sig-name descname">NONE</code><em class="property"> = VerificationMode(string='NONE')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.deployment_client.VerificationMode.THUMBPRINT">
|
||
<code class="sig-name descname">THUMBPRINT</code><em class="property"> = VerificationMode(string='THUMBPRINT')</em><a class="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
|
||
added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.guest_client">
|
||
<span id="com-vmware-vcenter-guest-client-module"></span><h2>com.vmware.vcenter.guest_client module<a class="headerlink" href="#module-com.vmware.vcenter.guest_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest_client</span></code> module provides classes for managing
|
||
guest customization specifications in the vCenter Server.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.guest_client.</code><code class="sig-name descname">CustomizationSpecs</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs</span></code> class provides methods to manage guest
|
||
customization specifications in the vCenter Server. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">names=None</em>, <em class="sig-param">os_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code> class contains attributes used to
|
||
filter the results when listing guest customization specifications (see
|
||
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list" title="com.vmware.vcenter.guest_client.CustomizationSpecs.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.list()</span></code></a>). If multiple attributes are specified,
|
||
only guest customization specifications matching all of the attributes
|
||
match the filter. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that guest customization specifications must have to match
|
||
the filter (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary.name</span></code>). 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
|
||
a value of this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.
|
||
If None or empty, guest customization specifications with any name
|
||
match the filter.</p></li>
|
||
<li><p><strong>os_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Guest operating system type that guest customization specifications
|
||
must have to match the filter (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary.os_type</span></code>). This attribute was
|
||
added in vSphere API 6.7.1.
|
||
If None, guest customization specifications with any guest
|
||
operating system type match the filter.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType">
|
||
<em class="property">class </em><code class="sig-name descname">OsType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code> class defines the types of guest
|
||
operating systems for which guest customization is supported. This
|
||
enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">OsType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.LINUX">
|
||
<code class="sig-name descname">LINUX</code><em class="property"> = OsType(string='LINUX')</em><a class="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
|
||
class attribute was added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.WINDOWS">
|
||
<code class="sig-name descname">WINDOWS</code><em class="property"> = OsType(string='WINDOWS')</em><a class="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
|
||
class attribute was added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.guest.CustomizationSpec'</em><a class="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
|
||
attribute was added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">os_type=None</em>, <em class="sig-param">last_modified=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary</span></code> class contains commonly used information
|
||
about a guest customization specification. This class was added in vSphere
|
||
API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the guest customization specification. 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
|
||
a value of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code></a>) – Guest operating system type for which that this guest customization
|
||
specification applies. This attribute was added in vSphere API
|
||
6.7.1.</p></li>
|
||
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="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
|
||
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>. This method was added in
|
||
vSphere API 6.7.1.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching guest customization specifications for
|
||
which information should be returned.
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a> with all attributes None
|
||
which means all guest customization specifications match the
|
||
filter.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list" title="com.vmware.vcenter.guest_client.CustomizationSpecs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Summary" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Commonly used information about the guest customization
|
||
specifications matching the <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec.os_type</span></code> attribute
|
||
contains a value that is not supported by the server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if more than 1000 guest customization specifications match the
|
||
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.guest_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.guest_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.hvc_client">
|
||
<span id="com-vmware-vcenter-hvc-client-module"></span><h2>com.vmware.vcenter.hvc_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc_client</span></code> module provides classes to manage hybrid
|
||
links between a local and remote Platform Service Controller.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc_client.</code><code class="sig-name descname">Links</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Links</span></code> class provides methods to create, delete, get information,
|
||
and list hybrid links between the local and foreign Platform Service
|
||
Controller (PSC). <strong>Warning:</strong> This class is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.CertificateInfo">
|
||
<em class="property">class </em><code class="sig-name descname">CertificateInfo</code><span class="sig-paren">(</span><em class="sig-param">ssl_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.CertificateInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Links.CertificateInfo</span></code> class contains information about the SSL
|
||
certificate for a destination PSC endpoint. <strong>Warning:</strong> This class is
|
||
available as technical preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The SHA-256 thumbprint of the SSL certificate for the destination
|
||
PSC endpoint. <strong>Warning:</strong> This attribute is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">psc_hostname=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">domain_name=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">admin_groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Links.CreateSpec</span></code> class is the specification used for the hybrid
|
||
link creation. <strong>Warning:</strong> This class is available as technical preview.
|
||
It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>psc_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The PSC hostname for the domain to be linked. <strong>Warning:</strong> This
|
||
attribute is available as technical preview. It may be changed in a
|
||
future release.</p></li>
|
||
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The HTTPS port of the PSC to be linked. <strong>Warning:</strong> This attribute
|
||
is available as technical preview. It may be changed in a future
|
||
release.
|
||
If None 443 will be used as default.</p></li>
|
||
<li><p><strong>domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The domain to which the PSC belongs. <strong>Warning:</strong> This attribute is
|
||
available as technical preview. It may be changed in a future
|
||
release.</p></li>
|
||
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The administrator username of the PSC. <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The administrator password of the PSC. <strong>Warning:</strong> This attribute
|
||
is available as technical preview. It may be changed in a future
|
||
release.</p></li>
|
||
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The ssl thumbprint of the server. <strong>Warning:</strong> This attribute is
|
||
available as technical preview. It may be changed in a future
|
||
release.
|
||
if None no thumbprint is passed.</p></li>
|
||
<li><p><strong>admin_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of groups to be added to enable administrator access to.
|
||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||
may be changed in a future release.
|
||
if None administrator access will not be set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.Credentials">
|
||
<em class="property">class </em><code class="sig-name descname">Credentials</code><span class="sig-paren">(</span><em class="sig-param">user_name=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.Credentials" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">link=None</em>, <em class="sig-param">display_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Links.Summary</span></code> class contains information about the hybrid link.
|
||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||
changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for the link. <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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
|
||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name is set to the domain name which was set during
|
||
create. <strong>Warning:</strong> This attribute is available as technical
|
||
preview. It may be changed in a future release.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
changed in a future release.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.CreateSpec" title="com.vmware.vcenter.hvc_client.Links.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.CreateSpec</span></code></a>) – Specification for the new link to be created.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the newly linked domain.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
If the link already exists.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If the values of any of the attributes of the <code class="docutils literal notranslate"><span class="pre">spec</span></code> parameter
|
||
are not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
If the PSC or the VC version is not supported.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user is not authorized.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
|
||
If the SSL certificate of the foreign PSC cannot be validated by
|
||
comparing with the thumbprint provided in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Links.CreateSpec.ssl_thumbprint</span></code> or if
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Links.CreateSpec.ssl_thumbprint</span></code> is None. The value of the
|
||
{\@link UnverifiedPeer#data) attribute will be a class that
|
||
contains all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.CertificateInfo" title="com.vmware.vcenter.hvc_client.Links.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.CertificateInfo</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.delete">
|
||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">link</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the hybrid link.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If the hybrid link associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user is not authorized.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.hvc_client.Links.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
release.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.list" title="com.vmware.vcenter.hvc_client.Links.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.Summary" title="com.vmware.vcenter.hvc_client.Links.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.list" title="com.vmware.vcenter.hvc_client.Links.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of hybrid link information.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.hvc_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.identity_client">
|
||
<span id="com-vmware-vcenter-identity-client-module"></span><h2>com.vmware.vcenter.identity_client module<a class="headerlink" href="#module-com.vmware.vcenter.identity_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity_client</span></code> module provides classes to manage
|
||
VcIdentity.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.identity_client.</code><code class="sig-name descname">Providers</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType">
|
||
<em class="property">class </em><code class="sig-name descname">ConfigType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2">
|
||
<code class="sig-name descname">Oauth2</code><em class="property"> = ConfigType(string='Oauth2')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc">
|
||
<code class="sig-name descname">Oidc</code><em class="property"> = ConfigType(string='Oidc')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">config_tag=None</em>, <em class="sig-param">oauth2=None</em>, <em class="sig-param">oidc=None</em>, <em class="sig-param">org_ids=None</em>, <em class="sig-param">is_default=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code> class contains the information used to create
|
||
an identity provider. <strong>Warning:</strong> This class is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec" title="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
|
||
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec" title="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
|
||
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies whether the provider is the default provider. Setting
|
||
<code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The user friendly name for the provider. This name can be used for
|
||
human-readable identification purposes, but it does not have to be
|
||
unique, as the system will use internal UUIDs to differentiate
|
||
providers. <strong>Warning:</strong> This attribute is available as technical
|
||
preview. It may be changed in a future release.
|
||
If None, the name will be the empty string</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">org_ids=None</em>, <em class="sig-param">config_tag=None</em>, <em class="sig-param">oauth2=None</em>, <em class="sig-param">oidc=None</em>, <em class="sig-param">is_default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info" title="com.vmware.vcenter.identity_client.Providers.Oauth2Info"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
|
||
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcInfo" title="com.vmware.vcenter.identity_client.Providers.OidcInfo"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
|
||
<li><p><strong>is_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Specifies whether the provider is the default provider.
|
||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||
may be changed in a future release.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod">
|
||
<em class="property">class </em><code class="sig-name descname">Oauth2AuthenticationMethod</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Oauth2AuthenticationMethod</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_BASIC">
|
||
<code class="sig-name descname">CLIENT_SECRET_BASIC</code><em class="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_JWT">
|
||
<code class="sig-name descname">CLIENT_SECRET_JWT</code><em class="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')</em><a class="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
|
||
be changed in a future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_POST">
|
||
<code class="sig-name descname">CLIENT_SECRET_POST</code><em class="property"> = Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.PRIVATE_KEY_JWT">
|
||
<code class="sig-name descname">PRIVATE_KEY_JWT</code><em class="property"> = Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">Oauth2CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">public_key_uri=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em>, <em class="sig-param">issuer=None</em>, <em class="sig-param">authentication_method=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="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> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2Info">
|
||
<em class="property">class </em><code class="sig-name descname">Oauth2Info</code><span class="sig-paren">(</span><em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">public_key_uri=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em>, <em class="sig-param">issuer=None</em>, <em class="sig-param">authentication_method=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Oauth2Summary</code><span class="sig-paren">(</span><em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">authentication_header=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
Authorization: Basic [base64Encode(clientId + “:” + secret)].
|
||
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">Oauth2UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">public_key_uri=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em>, <em class="sig-param">issuer=None</em>, <em class="sig-param">authentication_method=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2UpdateSpec</span></code> class contains the information used to
|
||
update the OAuth2 identity provider. <strong>Warning:</strong> This class is available
|
||
as technical preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code></a> or <code class="docutils literal notranslate"><span class="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> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">OidcCreateSpec</code><span class="sig-paren">(</span><em class="sig-param">discovery_endpoint=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcCreateSpec</span></code> class contains the information used to
|
||
create an OIDC identity provider. <strong>Warning:</strong> This class is available as
|
||
technical preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) – The 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.OidcInfo">
|
||
<em class="property">class </em><code class="sig-name descname">OidcInfo</code><span class="sig-paren">(</span><em class="sig-param">discovery_endpoint=None</em>, <em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">public_key_uri=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em>, <em class="sig-param">issuer=None</em>, <em class="sig-param">authentication_method=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcInfo</span></code> class contains information about an OIDC
|
||
identity provider. OIDC is a discovery protocol for OAuth2 configuration
|
||
metadata, so <code class="docutils literal notranslate"><span class="pre">Providers.OidcInfo</span></code> contains additional discovered OAuth2
|
||
metadata. <strong>Warning:</strong> This class is available as technical preview. It may
|
||
be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.OidcSummary">
|
||
<em class="property">class </em><code class="sig-name descname">OidcSummary</code><span class="sig-paren">(</span><em class="sig-param">auth_endpoint=None</em>, <em class="sig-param">token_endpoint=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">authentication_header=None</em>, <em class="sig-param">auth_query_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcSummary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcSummary</span></code> class contains commonly used information
|
||
about an OIDC identity provider. OIDC is a discovery protocol for OAuth2
|
||
configuration metadata, so <code class="docutils literal notranslate"><span class="pre">Providers.OidcSummary</span></code> contains discovered
|
||
OAuth2 metadata. <strong>Warning:</strong> This class is available as technical preview.
|
||
It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
Authorization: Basic [base64Encode(clientId + “:” + secret)].
|
||
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>key/value 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">OidcUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">discovery_endpoint=None</em>, <em class="sig-param">client_id=None</em>, <em class="sig-param">client_secret=None</em>, <em class="sig-param">claim_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcUpdateSpec</span></code> class contains the information used to
|
||
update the OIDC identity provider. <strong>Warning:</strong> This class is available as
|
||
technical preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">provider=None</em>, <em class="sig-param">config_tag=None</em>, <em class="sig-param">oauth2=None</em>, <em class="sig-param">oidc=None</em>, <em class="sig-param">is_default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class contains commonly used information about an
|
||
identity provider. <strong>Warning:</strong> This class is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p></li>
|
||
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary" title="com.vmware.vcenter.identity_client.Providers.Oauth2Summary"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
|
||
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcSummary" title="com.vmware.vcenter.identity_client.Providers.OidcSummary"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
|
||
<li><p><strong>is_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Specifies whether the provider is the default provider.
|
||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||
may be changed in a future release.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">config_tag=None</em>, <em class="sig-param">oauth2=None</em>, <em class="sig-param">oidc=None</em>, <em class="sig-param">org_ids=None</em>, <em class="sig-param">make_default=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code> class contains the information used to update
|
||
the identity provider. <strong>Warning:</strong> This class is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec" title="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
|
||
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec" title="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
|
||
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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>make_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies whether to make this the default provider. If
|
||
<code class="docutils literal notranslate"><span class="pre">makeDefault</span></code> is set to true, this provider will be flagged as
|
||
the default provider and any other providers that had previously
|
||
been flagged as the default will be made non-default. If
|
||
<code class="docutils literal notranslate"><span class="pre">makeDefault</span></code> is set to false, this provider’s default flag will
|
||
not be modified. <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The user friendly name for the provider. This name can be used for
|
||
human-readable identification purposes, but it does not have to be
|
||
unique, as the system will use internal UUIDs to differentiate
|
||
providers. <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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.CreateSpec" title="com.vmware.vcenter.identity_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) – the CreateSpec contains the information used to create the provider</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the created identity provider.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to caller.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if invalid arguments are provided in createSpec.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.delete">
|
||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">provider</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the provider to delete
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to caller.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if no provider found with the given provider identifier.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">provider</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the provider
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Info" title="com.vmware.vcenter.identity_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Detailed information of the specified identity provider.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to caller.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if no provider found with the given provider identifier.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.list" title="com.vmware.vcenter.identity_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Summary" title="com.vmware.vcenter.identity_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Commonly used information about the identity providers.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to caller.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.identity_client.Providers.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">provider</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the provider to update
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec" title="com.vmware.vcenter.identity_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) – the UpdateSpec contains the information used to update the provider</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to caller.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if invalid arguments are provided in updateSpec.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if no provider found with the given provider identifier.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.identity_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.identity_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.inventory_client">
|
||
<span id="com-vmware-vcenter-inventory-client-module"></span><h2>com.vmware.vcenter.inventory_client module<a class="headerlink" href="#module-com.vmware.vcenter.inventory_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.inventory_client</span></code> component provides methods and
|
||
classes for retrieving vCenter datastore and network information for a given
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of identifiers.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.inventory_client.Datastore">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.inventory_client.</code><code class="sig-name descname">Datastore</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> class provides methods to retrieve information about
|
||
datastores.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.inventory_client.Datastore.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Info</span></code> class contains information about a datastore.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> or <code class="docutils literal notranslate"><span class="pre">StoragePod</span></code>. When
|
||
methods return a value of this class as a return value, the
|
||
attribute will be one of <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> or <code class="docutils literal notranslate"><span class="pre">StoragePod</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.inventory_client.Datastore.find">
|
||
<code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">datastores</em><span class="sig-paren">)</span><a class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore identifier and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of the datastores for which information will be
|
||
returned.
|
||
The parameter must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="com.vmware.vcenter.inventory_client.Datastore.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Datastore information for the specified datastores. The key in the
|
||
return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore identifier and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore information.
|
||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if no datastore can be found for one or more of the datastore
|
||
identifiers in <code class="docutils literal notranslate"><span class="pre">datastores</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the parameter
|
||
<code class="docutils literal notranslate"><span class="pre">datastores</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.inventory_client.Network">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.inventory_client.</code><code class="sig-name descname">Network</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Network</span></code> class provides methods to retrieve information about
|
||
vCenter Server networks.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.inventory_client.Network.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Info</span></code> class contains information about a vCenter Server
|
||
network.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">Network</span></code>,
|
||
<code class="docutils literal notranslate"><span class="pre">DistributedVirtualPortgroup</span></code>, or <code class="docutils literal notranslate"><span class="pre">OpaqueNetwork</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be one of <code class="docutils literal notranslate"><span class="pre">Network</span></code>, <code class="docutils literal notranslate"><span class="pre">DistributedVirtualPortgroup</span></code>, or
|
||
<code class="docutils literal notranslate"><span class="pre">OpaqueNetwork</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.inventory_client.Network.find">
|
||
<code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">networks</em><span class="sig-paren">)</span><a class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network identifier and
|
||
the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of the vCenter Server networks for which information
|
||
will be returned.
|
||
The parameter must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Network.Info" title="com.vmware.vcenter.inventory_client.Network.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Network information for the specified vCenter Server networks. The
|
||
key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network identifier and
|
||
the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network information.
|
||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if no datastore can be found for one or more of the vCenter Server
|
||
network identifiers in <code class="docutils literal notranslate"><span class="pre">networks</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">networks</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.inventory_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.inventory_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.iso_client">
|
||
<span id="com-vmware-vcenter-iso-client-module"></span><h2>com.vmware.vcenter.iso_client module<a class="headerlink" href="#module-com.vmware.vcenter.iso_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="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>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.iso_client.Image">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.iso_client.</code><code class="sig-name descname">Image</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.Image" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.iso_client.Image.mount">
|
||
<code class="sig-name descname">mount</code><span class="sig-paren">(</span><em class="sig-param">library_item</em>, <em class="sig-param">vm</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the newly created virtual CD-ROM backed by the
|
||
specified ISO image.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If either <code class="docutils literal notranslate"><span class="pre">vm</span></code> or the <code class="docutils literal notranslate"><span class="pre">library_item</span></code> is not found.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If no .iso file is present on the library item.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
When the operation is not allowed on the virtual machine in its
|
||
current state.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
||
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Config.AddRemoveDevice</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.iso_client.Image.unmount">
|
||
<code class="sig-name descname">unmount</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">cdrom</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The device identifier of the CD-ROM.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If the virtual machine identified by <code class="docutils literal notranslate"><span class="pre">vm</span></code> is not found or the
|
||
<code class="docutils literal notranslate"><span class="pre">cdrom</span></code> does not identify a virtual CD-ROM in the virtual
|
||
machine.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
When the operation is not allowed on the virtual machine in its
|
||
current state.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
||
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Config.AddRemoveDevice</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code> referenced
|
||
by the parameter <code class="docutils literal notranslate"><span class="pre">cdrom</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.iso_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.iso_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.ovf_client">
|
||
<span id="com-vmware-vcenter-ovf-client-module"></span><h2>com.vmware.vcenter.ovf_client module<a class="headerlink" href="#module-com.vmware.vcenter.ovf_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="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>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.CertificateParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">CertificateParams</code><span class="sig-paren">(</span><em class="sig-param">issuer=None</em>, <em class="sig-param">subject=None</em>, <em class="sig-param">is_valid=None</em>, <em class="sig-param">is_self_signed=None</em>, <em class="sig-param">x509=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.CertificateParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CertificateParams</span></code> class contains information about the public key
|
||
certificate used to sign the OVF package. This class will only be returned
|
||
if the OVF package is signed.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate issuer. For example: /C=US/ST=California/L=Palo
|
||
Alto/O=VMware, Inc.
|
||
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>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate subject. For example:
|
||
/C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC
|
||
Avamar/CN=EMC Corporation.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.DeploymentOption">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">DeploymentOption</code><span class="sig-paren">(</span><em class="sig-param">key=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">default_choice=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentOption</span></code> class contains the information about a deployment
|
||
option as defined in the OVF specification.</p>
|
||
<p>This corresponds to the ovf:Configuration element of the
|
||
ovf:DeploymentOptionSection in the specification. The
|
||
ovf:DeploymentOptionSection specifies a discrete set of intended resource
|
||
allocation configurations. This class represents one item from that set.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – A <code class="xref py py-class docutils literal notranslate"><span class="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
|
||
is not the default.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.DeploymentOptionParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">DeploymentOptionParams</code><span class="sig-paren">(</span><em class="sig-param">deployment_options=None</em>, <em class="sig-param">selected_key=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentOptionParams</span></code> class describes the possible deployment
|
||
options as well as the choice provided by the user.</p>
|
||
<blockquote>
|
||
<div><p>This information based on the ovf:DeploymentOptionSection.</p>
|
||
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>deployment_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOption</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The selected deployment option. Identifies the
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOption</span></code></a> in the list in the <code class="docutils literal notranslate"><span class="pre">deploymentOptions</span></code>
|
||
attribute with a matching value in the <code class="xref py py-attr docutils literal notranslate"><span class="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
|
||
configuration, usually it’s the first one in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DeploymentOptionParams.deployment_options</span></code> <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">DiskProvisioningType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code> class defines the virtual disk provisioning
|
||
types that can be set for a disk on the target platform.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick">
|
||
<code class="sig-name descname">eagerZeroedThick</code><em class="property"> = DiskProvisioningType(string='eagerZeroedThick')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thick">
|
||
<code class="sig-name descname">thick</code><em class="property"> = DiskProvisioningType(string='thick')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thin">
|
||
<code class="sig-name descname">thin</code><em class="property"> = DiskProvisioningType(string='thin')</em><a class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ExportFlag">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ExportFlag</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ExportFlag</span></code> class provides methods for retrieving information about
|
||
the export flags supported by the server. Export flags can be specified in
|
||
a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a> to customize an OVF export.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">option=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ExportFlag.Info</span></code> class describes an export flag supported by the
|
||
server.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the export flag that is supported by the server.</p></li>
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the export flag.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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>
|
||
</dd>
|
||
</dl>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="com.vmware.vcenter.ovf_client.ExportFlag.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExportFlag.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of supported export flags.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ExtraConfig">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ExtraConfig</code><span class="sig-paren">(</span><em class="sig-param">key=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">virtual_system_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ExtraConfig</span></code> class contains the information about a vmw:ExtraConfig
|
||
element which can be used to specify configuration settings that are
|
||
transferred directly to the <code class="docutils literal notranslate"><span class="pre">.vmx</span></code> file. The behavior of the
|
||
vmw:ExtraConfig element is similar to the <code class="docutils literal notranslate"><span class="pre">extraConfig</span></code> property of the
|
||
<code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> object.
|
||
See the VMware vSphere API reference for details on this.</p>
|
||
<p>vmw:ExtraConfig elements may occur as direct child elements of a
|
||
VirtualHardwareSection, or as child elements of individual virtual hardware
|
||
items.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ExtraConfigParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ExtraConfigParams</code><span class="sig-paren">(</span><em class="sig-param">extra_configs=None</em>, <em class="sig-param">exclude_keys=None</em>, <em class="sig-param">include_keys=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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 <code class="docutils literal notranslate"><span class="pre">.vmx</span></code> file.</p>
|
||
<p>The behavior of the vmw:ExtraConfig element is similar to the
|
||
<code class="docutils literal notranslate"><span class="pre">extraConfig</span></code> property of the <code class="docutils literal notranslate"><span class="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
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> object. See the VMware vSphere API reference
|
||
for details on this.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>extra_configs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="com.vmware.vcenter.ovf_client.ExtraConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraConfig</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> if there are no extra
|
||
configuration elements in the OVF package.</p></li>
|
||
<li><p><strong>exclude_keys</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Specifies which extra configuration items in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> in
|
||
the <code class="docutils literal notranslate"><span class="pre">extraConfigs</span></code> <code class="docutils literal notranslate"><span class="pre">field</span></code> should be ignored during deployment.</p>
|
||
<p>If set, the given keys for extra configurations will be ignored
|
||
during deployment. The key is defined in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfig.key</span></code> attribute.
|
||
This attribute is optional in the input parameters when deploying
|
||
an OVF package. It is an error to set both this and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.include_keys</span></code>. This attribute is optional
|
||
in the result when retrieving information about an OVF package. It
|
||
is an error to set both this and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.include_keys</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>include_keys</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Specifies which extra configuration items in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> in
|
||
the <code class="docutils literal notranslate"><span class="pre">extraConfigs</span></code> <code class="docutils literal notranslate"><span class="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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfig.key</span></code> attribute.
|
||
This attribute is optional in the input parameters when deploying
|
||
an OVF package. It is an error to set both this and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.exclude_keys</span></code>. This attribute is optional
|
||
in the result when retrieving information about an OVF package. It
|
||
is an error to set both this and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.exclude_keys</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ImportFlag">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ImportFlag</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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 <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to customize
|
||
an OVF deployment.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">option=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ImportFlag.Info</span></code> class describes an import flag supported by the
|
||
deployment platform.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the import flag that is supported by the deployment
|
||
platform.</p></li>
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the import flag.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">rp</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>rp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="com.vmware.vcenter.ovf_client.ImportFlag.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportFlag.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of supported import flags.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If the resource pool associated with <code class="docutils literal notranslate"><span class="pre">rp</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">rp</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">IpAllocationParams</code><span class="sig-paren">(</span><em class="sig-param">supported_allocation_scheme=None</em>, <em class="sig-param">supported_ip_allocation_policy=None</em>, <em class="sig-param">ip_allocation_policy=None</em>, <em class="sig-param">supported_ip_protocol=None</em>, <em class="sig-param">ip_protocol=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams</span></code> class specifies how IP addresses are allocated
|
||
to OVF properties. In particular, it informs the deployment platform
|
||
whether the guest supports IPv4, IPv6, or both. It also specifies whether
|
||
the IP addresses can be obtained through DHCP or through the properties
|
||
provided in the OVF environment.</p>
|
||
<p>Ovf Property elements are exposed to the guest software through the OVF
|
||
environment. Each Property element exposed in the OVF environment shall be
|
||
constructed from the value of the ovf:key attribute. A Property element
|
||
contains a key/value pair, it may optionally specify type qualifiers using
|
||
the ovf:qualifiers attribute with multiple qualifiers separated by commas.</p>
|
||
<p>The settings in <code class="docutils literal notranslate"><span class="pre">IpAllocationParams</span></code> class are global to a deployment.
|
||
Thus, if a virtual machine is part of a virtual appliance, then its
|
||
settings are ignored and the settings for the virtual appliance is used.</p>
|
||
<blockquote>
|
||
<div><p>This information is based on the vmw:IpAssignmentSection in OVF package.</p>
|
||
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>supported_allocation_scheme</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"><code class="xref py py-class docutils literal notranslate"><span class="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
|
||
at deployment time. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.ip_allocation_policy</span></code>.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><code class="xref py py-class docutils literal notranslate"><span class="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
|
||
appliance software, as specified by the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.supported_allocation_scheme</span></code> attribute.
|
||
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> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><code class="xref py py-class docutils literal notranslate"><span class="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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.supported_ip_protocol</span></code>.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy">
|
||
<em class="property">class </em><code class="sig-name descname">IpAllocationPolicy</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></code> class defines the possible IP
|
||
allocation policy for a deployment.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationPolicy</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP">
|
||
<code class="sig-name descname">DHCP</code><em class="property"> = IpAllocationPolicy(string='DHCP')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL">
|
||
<code class="sig-name descname">STATIC_IPPOOL</code><em class="property"> = IpAllocationPolicy(string='STATIC_IPPOOL')</em><a class="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
|
||
consistent IP for its life-time.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL">
|
||
<code class="sig-name descname">STATIC_MANUAL</code><em class="property"> = IpAllocationPolicy(string='STATIC_MANUAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL">
|
||
<code class="sig-name descname">TRANSIENT_IPPOOL</code><em class="property"> = IpAllocationPolicy(string='TRANSIENT_IPPOOL')</em><a class="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
|
||
address when restarted.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme">
|
||
<em class="property">class </em><code class="sig-name descname">IpAllocationScheme</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationScheme</span></code> class defines the possible IP
|
||
allocation schemes that can be supported by the guest software.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationScheme</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP">
|
||
<code class="sig-name descname">DHCP</code><em class="property"> = IpAllocationScheme(string='DHCP')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT">
|
||
<code class="sig-name descname">OVF_ENVIRONMENT</code><em class="property"> = IpAllocationScheme(string='OVF_ENVIRONMENT')</em><a class="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
|
||
the OVF environment.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol">
|
||
<em class="property">class </em><code class="sig-name descname">IpProtocol</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpProtocol</span></code> class defines the IP protocols
|
||
supported by the guest software.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpProtocol</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4">
|
||
<code class="sig-name descname">IPV4</code><em class="property"> = IpProtocol(string='IPV4')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>It supports the IPv4 protocol.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6">
|
||
<code class="sig-name descname">IPV6</code><em class="property"> = IpProtocol(string='IPV6')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>It supports the IPv6 protocol.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">LibraryItem</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<ol class="arabic simple">
|
||
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> to specify the target
|
||
deployment type and target deployment designation.</p></li>
|
||
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to specify the
|
||
parameters for the target deployment.</p></li>
|
||
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method with the created target and parameter
|
||
specifications, along with the identifier of the specified source content
|
||
library item. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="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>
|
||
<ol class="arabic simple">
|
||
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code></a> to specify the target library
|
||
and library item.</p></li>
|
||
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a> to specify the settings for the
|
||
OVF package to be created.</p></li>
|
||
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">create</span></code> method with the created target and parameter
|
||
specifications, along with the specified source entity. See
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p></li>
|
||
</ol>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult">
|
||
<em class="property">class </em><code class="sig-name descname">CreateResult</code><span class="sig-paren">(</span><em class="sig-param">succeeded=None</em>, <em class="sig-param">ovf_library_item_id=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateResult</span></code> class defines the result of the <code class="docutils literal notranslate"><span class="pre">create</span></code>
|
||
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>succeeded</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether the <code class="docutils literal notranslate"><span class="pre">create</span></code> method completed successfully.</p></li>
|
||
<li><p><strong>ovf_library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
|
||
If None, the <code class="docutils literal notranslate"><span class="pre">create</span></code> method failed and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateResult.error</span></code> will describe the error(s)
|
||
that caused the failure.</p></li>
|
||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
|
||
<code class="docutils literal notranslate"><span class="pre">create</span></code> method.
|
||
If None, no errors, warnings, or informational messages were
|
||
reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> method.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">flags=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code> class defines the information used to create
|
||
or update a library item containing an OVF package.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flags to use for OVF package creation. The supported flags can be
|
||
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExportFlag.list()</span></code></a>.
|
||
If None, no flags will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget">
|
||
<em class="property">class </em><code class="sig-name descname">CreateTarget</code><span class="sig-paren">(</span><em class="sig-param">library_id=None</em>, <em class="sig-param">library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code> class specifies the target library item
|
||
when capturing a virtual machine or virtual appliance as an OVF package in
|
||
a library item in a content library. The target can be an existing library
|
||
item, which will be updated, creating a new version, or it can be a newly
|
||
created library item in a specified library. See
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the library in which a new library item should be
|
||
created. This attribute is not used if the <code class="docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
|
||
If None, the <code class="docutils literal notranslate"><span class="pre">libraryItemId</span></code> attribute must be specified.</p></li>
|
||
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
|
||
If None, a new library item will be created. The <code class="docutils literal notranslate"><span class="pre">libraryId</span></code>
|
||
attribute must be specified if this attribute is None.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE">
|
||
<code class="sig-name descname">DEPLOYABLE</code><em class="property"> = ['VirtualMachine', 'VirtualApp']</em><a class="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 <code class="docutils literal notranslate"><span class="pre">LibraryItem</span></code> class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity">
|
||
<em class="property">class </em><code class="sig-name descname">DeployableIdentity</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> or <code class="docutils literal notranslate"><span class="pre">VirtualApp</span></code>. When
|
||
methods return a value of this class as a return value, the
|
||
attribute will be one of <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> or <code class="docutils literal notranslate"><span class="pre">VirtualApp</span></code>.</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult">
|
||
<em class="property">class </em><code class="sig-name descname">DeploymentResult</code><span class="sig-paren">(</span><em class="sig-param">succeeded=None</em>, <em class="sig-param">resource_id=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult</span></code> class defines the result of the
|
||
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>succeeded</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method completed successfully.</p></li>
|
||
<li><p><strong>resource_id</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the deployed resource entity.
|
||
If None, the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method failed and
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult.error</span></code> will describe the
|
||
error(s) that caused the failure.</p></li>
|
||
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
|
||
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method.
|
||
If None, no errors, warnings, or informational messages were
|
||
reported by the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget">
|
||
<em class="property">class </em><code class="sig-name descname">DeploymentTarget</code><span class="sig-paren">(</span><em class="sig-param">resource_pool_id=None</em>, <em class="sig-param">host_id=None</em>, <em class="sig-param">folder_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code> class describes the location (target)
|
||
where a virtual machine or virtual appliance should be deployed. It is used
|
||
in the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code> methods. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>
|
||
and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>resource_pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
|
||
<li><p><strong>host_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
||
If None, the server will automatically select a target host from
|
||
the resource pool if
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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: <code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
||
If None, the server will choose the deployment folder.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary">
|
||
<em class="property">class </em><code class="sig-name descname">OvfSummary</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">annotation=None</em>, <em class="sig-param">eulas=None</em>, <em class="sig-param">networks=None</em>, <em class="sig-param">storage_groups=None</em>, <em class="sig-param">additional_params=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary</span></code> class defines the result of the <code class="docutils literal notranslate"><span class="pre">filter</span></code>
|
||
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Default 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – End User License Agreements specified in the OVF descriptor. All
|
||
end user license agreements must be accepted in order for the
|
||
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method to succeed. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula</span></code>.</p></li>
|
||
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Section identifiers for sections of type ovf:NetworkSection in the
|
||
OVF descriptor. These identifiers can be used as keys in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></code>.
|
||
If None, the OVF descriptor did not specify any networks.</p></li>
|
||
<li><p><strong>storage_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Section identifiers for sections of type vmw:StorageGroupSection in
|
||
the OVF descriptor. These identifiers can be used as keys in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_mappings</span></code>.
|
||
If None, the OVF descriptor did not specify any storage groups.</p></li>
|
||
<li><p><strong>additional_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional OVF parameters which can be specified for the deployment
|
||
target. These OVF parameters can be inspected, optionally modified,
|
||
and used as values in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.additional_parameters</span></code>
|
||
for the <code class="docutils literal notranslate"><span class="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
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="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
|
||
target.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ResourcePoolDeploymentSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">annotation=None</em>, <em class="sig-param">accept_all_eula=None</em>, <em class="sig-param">network_mappings=None</em>, <em class="sig-param">storage_mappings=None</em>, <em class="sig-param">storage_provisioning=None</em>, <em class="sig-param">storage_profile_id=None</em>, <em class="sig-param">locale=None</em>, <em class="sig-param">flags=None</em>, <em class="sig-param">additional_parameters=None</em>, <em class="sig-param">default_datastore_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code> class defines the deployment
|
||
parameters that can be specified for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method where the
|
||
deployment target is a resource pool. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether to accept all End User License Agreements. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary.eulas</span></code>.</p></li>
|
||
<li><p><strong>network_mappings</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of the target network to use for sections of type
|
||
ovf:NetworkSection in the OVF descriptor. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>. When methods return a value of this
|
||
class as a return value, the value in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>
|
||
will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
||
If None, the server will choose a network mapping.</p></li>
|
||
<li><p><strong>storage_mappings</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping</span></code></a>) or <code class="docutils literal notranslate"><span class="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
|
||
<code class="xref py py-class docutils literal notranslate"><span class="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
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping</span></code></a>.
|
||
If None, the server will choose a storage mapping.</p></li>
|
||
<li><p><strong>storage_provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Default 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>.
|
||
If None, the server will choose the default profile.</p></li>
|
||
<li><p><strong>locale</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The locale to use for parsing the OVF descriptor.
|
||
If None, the server locale will be used.</p></li>
|
||
<li><p><strong>flags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flags to be use for deployment. The supported flag values can be
|
||
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ImportFlag.list()</span></code></a>.
|
||
If None, no flags will be used.</p></li>
|
||
<li><p><strong>additional_parameters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="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
|
||
limited to:</p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="com.vmware.vcenter.ovf_client.DeploymentOptionParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOptionParams</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="com.vmware.vcenter.ovf_client.ExtraConfigParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraConfigParams</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="com.vmware.vcenter.ovf_client.IpAllocationParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="com.vmware.vcenter.ovf_client.PropertyParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyParams</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="com.vmware.vcenter.ovf_client.ScaleOutParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleOutParams</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="com.vmware.vcenter.ovf_client.VcenterExtensionParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">VcenterExtensionParams</span></code></a></p></li>
|
||
</ul>
|
||
<p>When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfParams</span></code></a>.
|
||
If None, the server will choose default settings for all parameters
|
||
necessary for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
|
||
</p></li>
|
||
<li><p><strong>default_datastore_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Default 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
If None, the server will choose the default datastore.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo">
|
||
<em class="property">class </em><code class="sig-name descname">ResultInfo</code><span class="sig-paren">(</span><em class="sig-param">errors=None</em>, <em class="sig-param">warnings=None</em>, <em class="sig-param">information=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code> class defines the information returned along
|
||
with the result of a <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method to describe errors,
|
||
warnings, and informational messages produced by the server.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfError" title="com.vmware.vcenter.ovf_client.OvfError"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfError</span></code></a>) – Errors reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. These
|
||
errors would have prevented the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method
|
||
from completing successfully.</p></li>
|
||
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="com.vmware.vcenter.ovf_client.OvfWarning"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfWarning</span></code></a>) – Warnings reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. These
|
||
warnings would not have prevented the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code>
|
||
method from completing successfully, but there might be issues that
|
||
warrant attention.</p></li>
|
||
<li><p><strong>information</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="com.vmware.vcenter.ovf_client.OvfInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfInfo</span></code></a>) – Information messages reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code>
|
||
method. For example, a non-required parameter was ignored.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping">
|
||
<em class="property">class </em><code class="sig-name descname">StorageGroupMapping</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">datastore_id=None</em>, <em class="sig-param">storage_profile_id=None</em>, <em class="sig-param">provisioning=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></code></a>) – Type of storage deployment target to use for the
|
||
vmw:StorageGroupSection section. The specified value must be
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></code></a>.</p></li>
|
||
<li><p><strong>datastore_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a>.</p></li>
|
||
<li><p><strong>storage_profile_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></code></a>.</p></li>
|
||
<li><p><strong>provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target provisioning type to use for the storage group.
|
||
If None,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning</span></code>
|
||
will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></code> class defines the supported
|
||
types of storage targets for sections of type vmw:StorageGroupSection in
|
||
the OVF descriptor.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE">
|
||
<code class="sig-name descname">DATASTORE</code><em class="property"> = Type(string='DATASTORE')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE">
|
||
<code class="sig-name descname">STORAGE_PROFILE</code><em class="property"> = Type(string='STORAGE_PROFILE')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">source</em>, <em class="sig-param">target</em>, <em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code></a>) – Specification of the target content library and library item.</p></li>
|
||
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a>) – Information used to create the OVF package from the source virtual
|
||
machine or virtual appliance.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the success or failure of the method, along with
|
||
the details of the result or failure.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> contains invalid arguments.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">source</span></code> describes an unexpected resource type.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine or virtual appliance specified by <code class="docutils literal notranslate"><span class="pre">source</span></code>
|
||
does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library or library item specified by <code class="docutils literal notranslate"><span class="pre">target</span></code> does not
|
||
exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation cannot be performed because of the specified
|
||
virtual machine or virtual appliance’s current state. For example,
|
||
if the virtual machine configuration information is not available,
|
||
or if the virtual appliance is running.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there was an error accessing a file from the source virtual
|
||
machine or virtual appliance.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the specified virtual machine or virtual appliance is busy.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity.id</span></code> requires <code class="docutils literal notranslate"><span class="pre">VApp.Export</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget.library_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.AddLibraryItem</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget.library_item_id</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.deploy">
|
||
<code class="sig-name descname">deploy</code><span class="sig-paren">(</span><em class="sig-param">ovf_library_item_id</em>, <em class="sig-param">target</em>, <em class="sig-param">deployment_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="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 <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>. It uses the deployment
|
||
specification in <code class="docutils literal notranslate"><span class="pre">deployment_spec</span></code> to deploy the OVF package to the
|
||
location specified by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
|
||
<dl class="field-list">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a>) – Specification of the deployment target.</p></li>
|
||
<li><p><strong>deployment_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>) – Specification of how the OVF package should be deployed to the
|
||
target.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the success or failure of the method, along with
|
||
the details of the result or failure.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">target</span></code> contains invalid arguments.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">deployment_spec</span></code> contains invalid arguments or has attributes
|
||
that are inconsistent with <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> does not
|
||
exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if any resource specified by a attribute of the
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> class, specified by
|
||
<code class="docutils literal notranslate"><span class="pre">target</span></code>, does not exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there was an error accessing the OVF package stored in the
|
||
library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><dl class="simple">
|
||
<dt><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> </dt><dd><p>if you do not have all of the privileges described as follows :</p>
|
||
</dd>
|
||
</dl>
|
||
<ul class="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
|
||
datastore if specified.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the parameter <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> value of
|
||
attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VApp.Import</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VApp.Import</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.filter">
|
||
<code class="sig-name descname">filter</code><span class="sig-paren">(</span><em class="sig-param">ovf_library_item_id</em>, <em class="sig-param">target</em><span class="sig-paren">)</span><a class="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
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
|
||
<p>This method retrieves information from the descriptor of the OVF
|
||
package stored in the library item specified by
|
||
<code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>. The information returned by the method can be
|
||
used to populate the deployment specification (see
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> when deploying the OVF
|
||
package to the deployment target specified by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ovf_library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the content library item containing the OVF package
|
||
to query.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a>) – Specification of the deployment target.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary" title="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information that can be used to populate the deployment
|
||
specification (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>)
|
||
when deploying the OVF package to the deployment target specified
|
||
by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">target</span></code> contains invalid arguments.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> does not
|
||
exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if any resource specified by a attribute of the
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> class, specified by
|
||
<code class="docutils literal notranslate"><span class="pre">target</span></code>, does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there was an error accessing the OVF package at the specified
|
||
<code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the parameter <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfError">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">OvfError</code><span class="sig-paren">(</span><em class="sig-param">category=None</em>, <em class="sig-param">issues=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfError" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfError</span></code> class describes an error related to accessing, validating,
|
||
deploying, or exporting an OVF package.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) – The message category.</p></li>
|
||
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Represents a server
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">OvfInfo</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfInfo</span></code> class contains informational messages related to accessing,
|
||
validating, deploying, or exporting an OVF package.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of localizable messages (see
|
||
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfMessage">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">OvfMessage</code><span class="sig-paren">(</span><em class="sig-param">category=None</em>, <em class="sig-param">issues=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfMessage</span></code> class describes a base OVF handling error message
|
||
related to accessing, validating, deploying, or exporting an OVF package.</p>
|
||
<p>These messages fall into different categories defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>:</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) – The message category.</p></li>
|
||
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Represents a server
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category">
|
||
<em class="property">class </em><code class="sig-name descname">Category</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code> class defines the categories of messages (see
|
||
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="com.vmware.vcenter.ovf_client.OvfMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage</span></code></a>).</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT">
|
||
<code class="sig-name descname">INPUT</code><em class="property"> = Category(string='INPUT')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER">
|
||
<code class="sig-name descname">SERVER</code><em class="property"> = Category(string='SERVER')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Server error.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION">
|
||
<code class="sig-name descname">VALIDATION</code><em class="property"> = Category(string='VALIDATION')</em><a class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">OvfParams</code><span class="sig-paren">(</span><em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfParams</span></code> class defines the common attributes for all OVF
|
||
deployment parameters. OVF parameters serve several purposes:</p>
|
||
<ul class="simple">
|
||
<li><p>Describe information about a given OVF package.</p></li>
|
||
<li><p>Describe default deployment configuration.</p></li>
|
||
<li><p>Describe possible deployment values based on the deployment environment.</p></li>
|
||
<li><p>Provide deployment-specific configuration.</p></li>
|
||
</ul>
|
||
<p>Each OVF parameters class specifies a particular configurable aspect of OVF
|
||
deployment. An aspect has both a query-model and a deploy-model. The
|
||
query-model is used when the OVF package is queried, and the deploy-model
|
||
is used when deploying an OVF package.</p>
|
||
<p>Most OVF parameter classes provide both informational and deployment
|
||
parameters. However, some are purely informational (for example, download
|
||
size) and some are purely deployment parameters (for example, the flag to
|
||
indicate whether registration as a vCenter extension is accepted).</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.OvfWarning">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">OvfWarning</code><span class="sig-paren">(</span><em class="sig-param">category=None</em>, <em class="sig-param">issues=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OvfWarning</span></code> class describes a warning related to accessing,
|
||
validating, deploying, or exporting an OVF package.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) – The message category.</p></li>
|
||
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of input parameter.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Represents a server
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
contain all the attributes defined in
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ParseIssue</code><span class="sig-paren">(</span><em class="sig-param">category=None</em>, <em class="sig-param">file=None</em>, <em class="sig-param">line_number=None</em>, <em class="sig-param">column_number=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<ul class="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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="com.vmware.vcenter.ovf_client.ParseIssue.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue.Category</span></code></a>) – The category of the parse issue.</p></li>
|
||
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the file in which the parse issue was found.</p></li>
|
||
<li><p><strong>line_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The line number of the line in the file (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ParseIssue.file</span></code>) where the parse issue was found (or -1 if
|
||
not applicable).</p></li>
|
||
<li><p><strong>column_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The position in the line (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">ParseIssue.line_number</span></code>) (or
|
||
-1 if not applicable).</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message describing the parse issue.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category">
|
||
<em class="property">class </em><code class="sig-name descname">Category</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ParseIssue.Category</span></code> class defines the categories of issues that can
|
||
be found when parsing files inside an OVF package (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>)
|
||
including OVF descriptor (which is an XML document), manifest and
|
||
certificate files, or exporting an OVF package.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL">
|
||
<code class="sig-name descname">ATTRIBUTE_ILLEGAL</code><em class="property"> = Category(string='ATTRIBUTE_ILLEGAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED">
|
||
<code class="sig-name descname">ATTRIBUTE_REQUIRED</code><em class="property"> = Category(string='ATTRIBUTE_REQUIRED')</em><a class="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
|
||
from an element in the OVF descriptor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL">
|
||
<code class="sig-name descname">ELEMENT_ILLEGAL</code><em class="property"> = Category(string='ELEMENT_ILLEGAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED">
|
||
<code class="sig-name descname">ELEMENT_REQUIRED</code><em class="property"> = Category(string='ELEMENT_REQUIRED')</em><a class="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
|
||
from the OVF descriptor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN">
|
||
<code class="sig-name descname">ELEMENT_UNKNOWN</code><em class="property"> = Category(string='ELEMENT_UNKNOWN')</em><a class="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
|
||
parsing an OVF descriptor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR">
|
||
<code class="sig-name descname">EXPORT_ERROR</code><em class="property"> = Category(string='EXPORT_ERROR')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR">
|
||
<code class="sig-name descname">GENERATE_ERROR</code><em class="property"> = Category(string='GENERATE_ERROR')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR">
|
||
<code class="sig-name descname">INTERNAL_ERROR</code><em class="property"> = Category(string='INTERNAL_ERROR')</em><a class="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
|
||
the request.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR">
|
||
<code class="sig-name descname">PARSE_ERROR</code><em class="property"> = Category(string='PARSE_ERROR')</em><a class="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>
|
||
<ul class="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>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION">
|
||
<code class="sig-name descname">SECTION_RESTRICTION</code><em class="property"> = Category(string='SECTION_RESTRICTION')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN">
|
||
<code class="sig-name descname">SECTION_UNKNOWN</code><em class="property"> = Category(string='SECTION_UNKNOWN')</em><a class="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
|
||
parsing an OVF descriptor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR">
|
||
<code class="sig-name descname">VALIDATION_ERROR</code><em class="property"> = Category(string='VALIDATION_ERROR')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL">
|
||
<code class="sig-name descname">VALUE_ILLEGAL</code><em class="property"> = Category(string='VALUE_ILLEGAL')</em><a class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.Property">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">Property</code><span class="sig-paren">(</span><em class="sig-param">class_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">instance_id=None</em>, <em class="sig-param">category=None</em>, <em class="sig-param">ui_optional=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.Property" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.class_id</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.id</span></code>,
|
||
and <code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>class_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>Whether a category is UI optional. This is only used if this
|
||
property starts a new category (see <code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.PropertyParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">PropertyParams</code><span class="sig-paren">(</span><em class="sig-param">properties=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PropertyParams</span></code> class contains a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of OVF properties
|
||
that can be configured when the OVF package is deployed.</p>
|
||
<blockquote>
|
||
<div><p>This is based on the ovf:ProductSection.</p>
|
||
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.Property" title="com.vmware.vcenter.ovf_client.Property"><code class="xref py py-class docutils literal notranslate"><span class="pre">Property</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of OVF properties.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ScaleOutGroup">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ScaleOutGroup</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">instance_count=None</em>, <em class="sig-param">minimum_instance_count=None</em>, <em class="sig-param">maximum_instance_count=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ScaleOutGroup</span></code> class contains information about a scale-out group.</p>
|
||
<p>It allows a virtual system collection to contain a set of children that are
|
||
homogeneous with respect to a prototypical virtual system or virtual system
|
||
collection. It shall cause the deployment function to replicate the
|
||
prototype a number of times, thus allowing the number of instantiated
|
||
virtual systems to be configured dynamically at deployment time.</p>
|
||
<blockquote>
|
||
<div><p>This is based on the ovf2:ScaleOutSection.</p>
|
||
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
<li><p><strong>minimum_instance_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The minimum scaling factor.
|
||
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. This will be 1 if
|
||
there is no explicit limit.</p></li>
|
||
<li><p><strong>maximum_instance_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The maximum scaling factor.
|
||
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. This will be None if
|
||
there is no explicit limit.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.ScaleOutParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">ScaleOutParams</code><span class="sig-paren">(</span><em class="sig-param">groups=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ScaleOutParams</span></code> class contains information about the scale-out
|
||
groups described in the OVF package.</p>
|
||
<p>When deploying an OVF package, a deployment specific instance count can be
|
||
specified (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">ScaleOutGroup.instance_count</span></code>.</p>
|
||
<blockquote>
|
||
<div><p>This is based on the ovf2:ScaleOutSection.</p>
|
||
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="com.vmware.vcenter.ovf_client.ScaleOutGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleOutGroup</span></code></a>) – The <code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.SizeParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">SizeParams</code><span class="sig-paren">(</span><em class="sig-param">approximate_download_size=None</em>, <em class="sig-param">approximate_flat_deployment_size=None</em>, <em class="sig-param">approximate_sparse_deployment_size=None</em>, <em class="sig-param">variable_disk_size=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.SizeParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">SizeParams</span></code> class contains estimates of the download and deployment
|
||
sizes.</p>
|
||
<p>This information is based on the file references and the ovf:DiskSection in
|
||
the OVF descriptor.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>approximate_download_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.UnknownSection">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">UnknownSection</code><span class="sig-paren">(</span><em class="sig-param">tag=None</em>, <em class="sig-param">info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">UnknownSection</span></code> class contains information about an unknown section
|
||
in an OVF package.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A namespace-qualified tag in the form <code class="docutils literal notranslate"><span class="pre">{ns}tag</span></code>.</p></li>
|
||
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the Info element.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.UnknownSectionParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">UnknownSectionParams</code><span class="sig-paren">(</span><em class="sig-param">unknown_sections=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSectionParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">UnknownSectionParams</span></code> class contains a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of unknown,
|
||
non-required sections.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>unknown_sections</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="com.vmware.vcenter.ovf_client.UnknownSection"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnknownSection</span></code></a>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of unknown, non-required sections.
|
||
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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.ovf_client.VcenterExtensionParams">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.ovf_client.</code><code class="sig-name descname">VcenterExtensionParams</code><span class="sig-paren">(</span><em class="sig-param">required=None</em>, <em class="sig-param">registration_accepted=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">VcenterExtensionParams</span></code> class specifies that the OVF package should
|
||
be registered as a vCenter extension. The virtual machine or virtual
|
||
appliance will gain unrestricted access to the vCenter Server APIs. It must
|
||
be connected to a network with connectivity to the vCenter server.</p>
|
||
<blockquote>
|
||
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>Whether registration as a vCenter extension is accepted.</p>
|
||
<p>If registration as a vCenter extension is required (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.services_client">
|
||
<span id="com-vmware-vcenter-services-client-module"></span><h2>com.vmware.vcenter.services_client module<a class="headerlink" href="#module-com.vmware.vcenter.services_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.services_client.</code><code class="sig-name descname">Service</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service.Health">
|
||
<em class="property">class </em><code class="sig-name descname">Health</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Health" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service.Health</span></code> class defines the possible values for health of a
|
||
service. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.Health.DEGRADED">
|
||
<code class="sig-name descname">DEGRADED</code><em class="property"> = Health(string='DEGRADED')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.Health.HEALTHY">
|
||
<code class="sig-name descname">HEALTHY</code><em class="property"> = Health(string='HEALTHY')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.Health.HEALTHY_WITH_WARNINGS">
|
||
<code class="sig-name descname">HEALTHY_WITH_WARNINGS</code><em class="property"> = Health(string='HEALTHY_WITH_WARNINGS')</em><a class="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
|
||
API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name_key=None</em>, <em class="sig-param">description_key=None</em>, <em class="sig-param">startup_type=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">health=None</em>, <em class="sig-param">health_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service.Info</span></code> class contains information about a service. This class
|
||
was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType" title="com.vmware.vcenter.services_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a>) – Startup Type. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State" title="com.vmware.vcenter.services_client.Service.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.State</span></code></a>) – Running State. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Health" title="com.vmware.vcenter.services_client.Service.Health"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STARTED" title="com.vmware.vcenter.services_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
|
||
<li><p><strong>health_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – 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 <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STARTED" title="com.vmware.vcenter.services_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service.StartupType">
|
||
<em class="property">class </em><code class="sig-name descname">StartupType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.StartupType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service.StartupType</span></code> class defines valid Startup Type for vCenter
|
||
Server services. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">StartupType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.StartupType.AUTOMATIC">
|
||
<code class="sig-name descname">AUTOMATIC</code><em class="property"> = StartupType(string='AUTOMATIC')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.StartupType.DISABLED">
|
||
<code class="sig-name descname">DISABLED</code><em class="property"> = StartupType(string='DISABLED')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.StartupType.MANUAL">
|
||
<code class="sig-name descname">MANUAL</code><em class="property"> = StartupType(string='MANUAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service.State">
|
||
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service.State</span></code> class defines valid Run State for services. This
|
||
enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.State.STARTED">
|
||
<code class="sig-name descname">STARTED</code><em class="property"> = State(string='STARTED')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.State.STARTING">
|
||
<code class="sig-name descname">STARTING</code><em class="property"> = State(string='STARTING')</em><a class="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
|
||
attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.State.STOPPED">
|
||
<code class="sig-name descname">STOPPED</code><em class="property"> = State(string='STOPPED')</em><a class="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
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.services_client.Service.State.STOPPING">
|
||
<code class="sig-name descname">STOPPING</code><em class="property"> = State(string='STOPPING')</em><a class="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
|
||
was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.Service.UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">startup_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>startup_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType" title="com.vmware.vcenter.services_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Startup Type. This attribute was added in vSphere API 6.7.
|
||
If unspecified, leaves value unchanged.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service whose state is being queried.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Info" title="com.vmware.vcenter.services_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Service Info structure.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any other error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.list_details">
|
||
<code class="sig-name descname">list_details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Info" title="com.vmware.vcenter.services_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Map of service identifiers to service Info structures.
|
||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.restart">
|
||
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to restart
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
||
if any timeout occurs during the execution of the restart
|
||
operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation is denied in the current state of the service. If
|
||
a stop or start operation is in progress, issuing a restart
|
||
operation will lead to this error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if a restart operation is issued on a service which has startup
|
||
type <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any other error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.start">
|
||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to start
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation is denied in the current state of the service. If
|
||
a stop or restart operation is in progress, the start operation
|
||
will not be allowed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if start operation is issued on a service which has startup type
|
||
<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
||
if any timeout occurs during the execution of the start operation.
|
||
Timeout occurs when the service takes longer than StartTimeout to
|
||
start.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any other error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.stop">
|
||
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to stop
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any other error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation is denied in the current state of the service. If
|
||
a stop operation is in progress, issuing another stop operation
|
||
will lead to this error.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.services_client.Service.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">service</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service whose properties are being updated.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.UpdateSpec" title="com.vmware.vcenter.services_client.Service.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.UpdateSpec</span></code></a>) – Service Update specification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if any other error occurs during the execution of the operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation is denied in the current state of the service. If
|
||
a start, stop or restart operation is in progress, update operation
|
||
will fail with this error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if a request to set the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.UpdateSpec.startup_type</span></code>
|
||
attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> to <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a> comes
|
||
in for a service that is not in <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STOPPED" title="com.vmware.vcenter.services_client.Service.State.STOPPED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STOPPED</span></code></a>
|
||
state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.services_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.services_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.storage_client">
|
||
<span id="com-vmware-vcenter-storage-client-module"></span><h2>com.vmware.vcenter.storage_client module<a class="headerlink" href="#module-com.vmware.vcenter.storage_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage_client.</code><code class="sig-name descname">Policies</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies</span></code> class provides methods for managing the storage policies.
|
||
This class was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.CompatibilityInfo">
|
||
<em class="property">class </em><code class="sig-name descname">CompatibilityInfo</code><span class="sig-paren">(</span><em class="sig-param">compatible_datastores=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.CompatibilityInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>compatible_datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo" title="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"><code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo">
|
||
<em class="property">class </em><code class="sig-name descname">CompatibleDatastoreInfo</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.CompatibleDatastoreInfo</span></code> class contains compatible
|
||
datastore’s information. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datastore. 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">policies=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing the storage policies (see <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.list" title="com.vmware.vcenter.storage_client.Policies.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Policies.list()</span></code></a>). This
|
||
class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
||
If None or empty, storage policies with any identifiers match the
|
||
filter.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.StoragePolicy'</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">policy=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.Summary</span></code> class contains commonly used information about a
|
||
storage policy. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the storage policy. This attribute was added in
|
||
vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.check_compatibility">
|
||
<code class="sig-name descname">check_compatibility</code><span class="sig-paren">(</span><em class="sig-param">policy</em>, <em class="sig-param">datastores</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The storage policy identifier
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p></li>
|
||
<li><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.CompatibilityInfo" title="com.vmware.vcenter.storage_client.Policies.CompatibilityInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.CompatibilityInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>datastore compatibility summary about a specific storage policy.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the storage policy specified does not exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if input more than 1024 datastores.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.storage_client.Policies.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching storage policies for which information
|
||
should be returned.
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> with all attributes None which means
|
||
all storage policies match the filter</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.list" title="com.vmware.vcenter.storage_client.Policies.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.Summary" title="com.vmware.vcenter.storage_client.Policies.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Commonly used Information about the storage policies.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> contains a value that is not
|
||
supported by the server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if more than 1024 storage policies exist.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.storage_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.system_config_client">
|
||
<span id="com-vmware-vcenter-system-config-client-module"></span><h2>com.vmware.vcenter.system_config_client module<a class="headerlink" href="#module-com.vmware.vcenter.system_config_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.system_config_client.</code><code class="sig-name descname">DeploymentType</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentType</span></code> class provides methods to get/set the type of the
|
||
appliance. This class was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ConvergenceSpec</code><span class="sig-paren">(</span><em class="sig-param">psc=None</em>, <em class="sig-param">replication_partner_hostname=None</em>, <em class="sig-param">only_precheck=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>psc</strong> (<a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.PscInfo" title="com.vmware.vcenter.system_config_client.DeploymentType.PscInfo"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The (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 <code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to pass if only pre-check to be performed. This attribute was
|
||
added in vSphere API 6.7.2.
|
||
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will perform only pre-checks.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo">
|
||
<em class="property">class </em><code class="sig-name descname">DomainInfo</code><span class="sig-paren">(</span><em class="sig-param">ad_domain_name=None</em>, <em class="sig-param">ad_domain_admin_username=None</em>, <em class="sig-param">ad_domain_admin_password=None</em>, <em class="sig-param">dns_server=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ad_domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentType.Info</span></code> class contains the fields used to get the
|
||
appliance type. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.PscInfo">
|
||
<em class="property">class </em><code class="sig-name descname">PscInfo</code><span class="sig-paren">(</span><em class="sig-param">sso_admin_username=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">skip_ad_domain_join=None</em>, <em class="sig-param">ad_domain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.PscInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso_admin_username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A flag to 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will skip AD domain join operations</p></li>
|
||
<li><p><strong>ad_domain</strong> (<a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo" title="com.vmware.vcenter.system_config_client.DeploymentType.DomainInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.DomainInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> then converged embedded node will be joined to this
|
||
AD domain.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ReconfigureSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">remote_psc=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
||
VCSA_EXTERNAL.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.convert_to_vcsa_embedded_task">
|
||
<code class="sig-name descname">convert_to_vcsa_embedded_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec" title="com.vmware.vcenter.system_config_client.DeploymentType.ConvergenceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.ConvergenceSpec</span></code></a>) – ConvergenceSpec to provide all needed information for convergence
|
||
operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the appliance is in not a management node.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is already an embedded node.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.Info" title="com.vmware.vcenter.system_config_client.DeploymentType.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The type of the vCenter appliance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if appliance is not in CONFIGURED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.reconfigure">
|
||
<code class="sig-name descname">reconfigure</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec" title="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.ReconfigureSpec</span></code></a>) – ReconfigureSpec to set the appliance type.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the appliance is in CONFIGURED state and if not changing the
|
||
type from VCSA_EMBEDDED to VCSA_EXTERNAL.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if external PSC credentials are not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is not in INITIALIZED or CONFIGURED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.PscRegistration">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.system_config_client.</code><code class="sig-name descname">PscRegistration</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">sso_domain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PscRegistration.Info</span></code> class has fields to specify information about
|
||
the PSC node. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the PSC this appliance is
|
||
registered with. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The Single Sign-On domain name of the external PSC. This attribute
|
||
was added in vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
||
method was added in vSphere API 6.7.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.system_config_client.PscRegistration.Info" title="com.vmware.vcenter.system_config_client.PscRegistration.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">PscRegistration.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Info structure containing information about the external PSC node
|
||
this appliance is registered with.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is in NOT_INITIALIZED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.repoint">
|
||
<code class="sig-name descname">repoint</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the passed external PSC credentials is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the passed external PSC is not a replicating with the current
|
||
PSC this appliance is registered with.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the current appliance is not of the type VCSA_EXTERNAL.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the appliance is NOT in CONFIGURED state.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.system_config_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.system_config_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.tokenservice_client">
|
||
<span id="com-vmware-vcenter-tokenservice-client-module"></span><h2>com.vmware.vcenter.tokenservice_client module<a class="headerlink" href="#module-com.vmware.vcenter.tokenservice_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client</span></code> module provides Token classes.</p>
|
||
<dl class="exception">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.Error">
|
||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">Error</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.Error" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.error.VapiError</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Error</span></code> exception describes theattributes common to all standard
|
||
exceptions.</p>
|
||
<blockquote>
|
||
<div><p>This exception serves two purposes:</p>
|
||
</div></blockquote>
|
||
<ol class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
</ol>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="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. <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.InvalidGrant">
|
||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">InvalidGrant</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidGrant" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidGrant</span></code> exception indicates that provided authorization grant
|
||
(e.g., authorization code, resource owner credentials) or refresh token is
|
||
invalid, expired, revoked, does not match the redirection URI used in the
|
||
authorization request, or was issued to another client. <strong>Warning:</strong> This
|
||
class is available as technical preview. It may be changed in a future
|
||
release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="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. <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.InvalidRequest">
|
||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">InvalidRequest</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidRequest" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidRequest</span></code> exception indicates that
|
||
<a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code></a> is missing a required parameter,
|
||
includes an unsupported parameter value (other than
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="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. <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.InvalidScope">
|
||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">InvalidScope</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidScope" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidScope</span></code> exception indicates requested scope is invalid,
|
||
unknown, malformed, or exceeds the scope granted by the resource owner.
|
||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||
changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="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. <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.tokenservice_client.</code><code class="sig-name descname">TokenExchange</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange</span></code> interface provides possibility to exchange between
|
||
different tokens types. Implementation of “OAuth 2.0 Token Exchange”
|
||
standard (<a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ACCESS_TOKEN_TYPE">
|
||
<code class="sig-name descname">ACCESS_TOKEN_TYPE</code><em class="property"> = 'urn:ietf:params:oauth:token-type:access_token'</em><a class="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
|
||
release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.BEARER_TOKEN_METHOD_TYPE">
|
||
<code class="sig-name descname">BEARER_TOKEN_METHOD_TYPE</code><em class="property"> = 'Bearer'</em><a class="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
|
||
changed in a future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ExchangeSpec</code><span class="sig-paren">(</span><em class="sig-param">grant_type=None</em>, <em class="sig-param">resource=None</em>, <em class="sig-param">audience=None</em>, <em class="sig-param">scope=None</em>, <em class="sig-param">requested_token_type=None</em>, <em class="sig-param">subject_token=None</em>, <em class="sig-param">subject_token_type=None</em>, <em class="sig-param">actor_token=None</em>, <em class="sig-param">actor_token_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments required for
|
||
token exchange. <strong>Warning:</strong> This class is available as technical preview.
|
||
It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>grant_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT" title="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"><code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The logical name of the target service where the client intends to
|
||
use the requested security token. This serves a purpose similar to
|
||
the <code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.resource</span></code> or
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.audience</span></code> parameter. <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>subject_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.subject_token</span></code> parameter.
|
||
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – An identifier, that indicates the type of the security token in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.actor_token</span></code> parameter.
|
||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||
may be changed in a future release.
|
||
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.actor_token</span></code> parameter is not
|
||
present.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ID_TOKEN_TYPE">
|
||
<code class="sig-name descname">ID_TOKEN_TYPE</code><em class="property"> = 'urn:ietf:params:oauth:token-type:id_token'</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">access_token=None</em>, <em class="sig-param">issued_token_type=None</em>, <em class="sig-param">token_type=None</em>, <em class="sig-param">expires_in=None</em>, <em class="sig-param">scope=None</em>, <em class="sig-param">refresh_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code> class contains data that represents successful
|
||
token exchange response. <strong>Warning:</strong> This class is available as technical
|
||
preview. It may be changed in a future release.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>access_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.Info.access_token</span></code> parameter. <strong>Warning:</strong>
|
||
This attribute is available as technical preview. It may be changed
|
||
in a future release.</p></li>
|
||
<li><p><strong>token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE">
|
||
<code class="sig-name descname">N_A_TOKEN_METHOD_TYPE</code><em class="property"> = 'N_A'</em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Class attribute indicates <code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.Info.token_type</span></code> identifier is
|
||
not applicable in that context. <strong>Warning:</strong> This class attribute is available
|
||
as technical preview. It may be changed in a future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.REFRESH_TOKEN_TYPE">
|
||
<code class="sig-name descname">REFRESH_TOKEN_TYPE</code><em class="property"> = 'urn:ietf:params:oauth:token-type:refresh_token'</em><a class="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
|
||
release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.SAML1_TOKEN_TYPE">
|
||
<code class="sig-name descname">SAML1_TOKEN_TYPE</code><em class="property"> = 'urn:ietf:params:oauth:token-type:saml1'</em><a class="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
|
||
future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.SAML2_TOKEN_TYPE">
|
||
<code class="sig-name descname">SAML2_TOKEN_TYPE</code><em class="property"> = 'urn:ietf:params:oauth:token-type:saml2'</em><a class="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
|
||
future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT">
|
||
<code class="sig-name descname">TOKEN_EXCHANGE_GRANT</code><em class="property"> = 'urn:ietf:params:oauth:grant-type:token-exchange'</em><a class="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
|
||
future release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.exchange">
|
||
<code class="sig-name descname">exchange</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code></a>) – <code class="docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments that define
|
||
exchange process.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code></a> class that contains new token.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.InvalidGrant" title="com.vmware.vcenter.tokenservice_client.InvalidGrant"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidGrant</span></code></a>
|
||
provided authorization grant (e.g., authorization code, resource
|
||
owner credentials) or refresh token is invalid, expired, revoked,
|
||
does not match the redirection URI used in the authorization
|
||
request, or was issued to another client.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.InvalidScope" title="com.vmware.vcenter.tokenservice_client.InvalidScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidScope</span></code></a>
|
||
If the server is unwilling or unable to issue a token for all the
|
||
target services indicated by the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.resource</span></code> or
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.audience</span></code> parameters.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if authorization is not given to a caller.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.topology_client">
|
||
<span id="com-vmware-vcenter-topology-client-module"></span><h2>com.vmware.vcenter.topology_client module<a class="headerlink" href="#module-com.vmware.vcenter.topology_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.topology_client.</code><code class="sig-name descname">Nodes</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType">
|
||
<em class="property">class </em><code class="sig-name descname">ApplianceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code> class defines values for valid appliance types
|
||
for the vCenter and Platform Services Controller node. See
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a>. This enumeration was added in vSphere API 6.7.2.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL">
|
||
<code class="sig-name descname">PSC_EXTERNAL</code><em class="property"> = ApplianceType(string='PSC_EXTERNAL')</em><a class="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
|
||
vSphere API 6.7.2.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED">
|
||
<code class="sig-name descname">VCSA_EMBEDDED</code><em class="property"> = ApplianceType(string='VCSA_EMBEDDED')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL">
|
||
<code class="sig-name descname">VCSA_EXTERNAL</code><em class="property"> = ApplianceType(string='VCSA_EXTERNAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">types=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code> class contains attribute used to filter the
|
||
results when listing vCenter and Platform Services Controller nodes (see
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.list" title="com.vmware.vcenter.topology_client.Nodes.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Nodes.list()</span></code></a>). This class was added in vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Types of the appliance that a vCenter and Platform Services
|
||
Controller node must be to match the filter (see
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">domain=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">replication_partners=None</em>, <em class="sig-param">client_affinity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.Info</span></code> class contains vCenter or Platform Services Controller
|
||
node details. This class was added in vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.PSC_EXTERNAL</span></code></a>.</p></li>
|
||
<li><p><strong>client_affinity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the affinitized Platform Services Controller node.
|
||
Identifier can be either IP address or DNS resolvable name of the
|
||
affinitized 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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EXTERNAL</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">node=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">replication_partners=None</em>, <em class="sig-param">client_affinity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.PSC_EXTERNAL</span></code></a>.</p></li>
|
||
<li><p><strong>client_affinity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the affinitized Platform Services Controller node.
|
||
Identifier can be either IP address or DNS resolvable name of the
|
||
affinitized 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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EXTERNAL</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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
|
||
node.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>vCenter or Platform Services Controller node details with
|
||
replication partners and client affinity information as applicable.
|
||
See <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a node doesn’t exist for given node identifier.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.topology_client.Nodes.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="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 <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>. This method was added in
|
||
vSphere API 6.7.2.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>
|
||
with all attributes None which means all nodes match the filter.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.list" title="com.vmware.vcenter.topology_client.Nodes.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Summary" title="com.vmware.vcenter.topology_client.Nodes.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>commonly used information for all vCenter and Platform Services
|
||
Controller nodes matching the <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.FilterSpec.types</span></code> attribute contains a value
|
||
that is not supported.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Pscs">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.topology_client.</code><code class="sig-name descname">Pscs</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Pscs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.Pscs.DecommissionSpec">
|
||
<em class="property">class </em><code class="sig-name descname">DecommissionSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_admin_username=None</em>, <em class="sig-param">sso_admin_password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">ssl_verify=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Pscs.DecommissionSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Pscs.DecommissionSpec</span></code> class contains information about the Platform
|
||
Services Controller node to be decommissioned. This class was added in
|
||
vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso_admin_username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> or
|
||
has the value true. No verification will be performed if
|
||
<code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> value is set to false.</p></li>
|
||
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
|
||
added in vSphere API 6.7.2.
|
||
If None, ssl_verify false will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.topology_client.Pscs.decommission_task">
|
||
<code class="sig-name descname">decommission_task</code><span class="sig-paren">(</span><em class="sig-param">hostname</em>, <em class="sig-param">spec</em>, <em class="sig-param">only_precheck=None</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN or IP address of external Platform Services Controller node to
|
||
be decommissioned.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Pscs.DecommissionSpec" title="com.vmware.vcenter.topology_client.Pscs.DecommissionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pscs.DecommissionSpec</span></code></a>) – Information needed to decommission the external Platform Services
|
||
Controller node.</p></li>
|
||
<li><p><strong>only_precheck</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether only a pre-check should be performed.
|
||
If None the full decommission will be performed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the appliance is in not a management node.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if passed arguments are invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
|
||
If the SSL certificate of the foreign external Platform Services
|
||
Controller node cannot be validated.
|
||
The value of the data attribute of null will be a class that
|
||
contains all the attributes defined in null.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the provided Platform Services Controller node doesn’t qualify
|
||
for decommission due to some reasons like it has some other nodes
|
||
connected to it.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.topology_client.</code><code class="sig-name descname">ReplicationStatus</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>).
|
||
This class was added in vSphere API 6.7.2.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">nodes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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 <a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.list" title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ReplicationStatus.list()</span></code></a>) of
|
||
type VCSA_EMBEDDED/PSC_EXTERNAL (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>). This class
|
||
was added in vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>nodes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier that a vCenter and Platform Services Controller node
|
||
must have to match the filter. (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.node</span></code>). 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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
|
||
If None or empty, all vCenter and Platform Services Controller
|
||
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">node=None</em>, <em class="sig-param">replication_partner=None</em>, <em class="sig-param">partner_available=None</em>, <em class="sig-param">status_available=None</em>, <em class="sig-param">replicating=None</em>, <em class="sig-param">change_lag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicationStatus.Summary</span></code> class contains replication information of
|
||
partner vCenter or Platform Services Controller node of type
|
||
VCSA_EMBEDDED/PSC_EXTERNAL (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>). This class was
|
||
added in vSphere API 6.7.2.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
|
||
<li><p><strong>replication_partner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
|
||
<li><p><strong>partner_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.partner_available</span></code> or
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
|
||
<li><p><strong>change_lag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of 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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.partner_available</span></code> or
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>) matching the
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a>. This method was added in vSphere
|
||
API 6.7.2.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.list" title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.Summary" title="com.vmware.vcenter.topology_client.ReplicationStatus.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Commonly used replication information about vCenter and Platform
|
||
Services Controller nodes matching the
|
||
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec.nodes</span></code> attribute
|
||
contains a invalid value.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.topology_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.topology_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.vcha_client">
|
||
<span id="com-vmware-vcenter-vcha-client-module"></span><h2>com.vmware.vcenter.vcha_client module<a class="headerlink" href="#module-com.vmware.vcenter.vcha_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client</span></code> module provides classes for deploying
|
||
and monitoring a vCenter High Availability (VCHA) Cluster.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.CertificateInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">CertificateInfo</code><span class="sig-paren">(</span><em class="sig-param">ssl_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CertificateInfo</span></code> Class contains information about the SSL
|
||
certificate for a management vCenter server. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">Cluster</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ActiveSpec</code><span class="sig-paren">(</span><em class="sig-param">ha_network_type=None</em>, <em class="sig-param">ha_network=None</em>, <em class="sig-param">ha_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ActiveSpec</span></code> class contains the deploy specification for the
|
||
Active Node of the VCHA cluster. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ha_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of the Network object used by the HA network.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
|
||
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> field must be set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
|
||
then the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
|
||
unset, then the second NIC is assumed to be already configured.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
|
||
set, then an error is reported.</p></li>
|
||
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of the Network object used for the HA network.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
|
||
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute must be
|
||
set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
|
||
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
|
||
set, then an error is reported.</p></li>
|
||
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
|
||
vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode">
|
||
<em class="property">class </em><code class="sig-name descname">ClusterMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ClusterMode</span></code> class defines the possible modes for a VCHA
|
||
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterMode</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.DISABLED">
|
||
<code class="sig-name descname">DISABLED</code><em class="property"> = ClusterMode(string='DISABLED')</em><a class="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
|
||
attribute was added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.ENABLED">
|
||
<code class="sig-name descname">ENABLED</code><em class="property"> = ClusterMode(string='ENABLED')</em><a class="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
|
||
added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.MAINTENANCE">
|
||
<code class="sig-name descname">MAINTENANCE</code><em class="property"> = ClusterMode(string='MAINTENANCE')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState">
|
||
<em class="property">class </em><code class="sig-name descname">ClusterState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ClusterState</span></code> class defines the possible for a VCHA Cluster.
|
||
This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterState</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.DEGRADED">
|
||
<code class="sig-name descname">DEGRADED</code><em class="property"> = ClusterState(string='DEGRADED')</em><a class="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>
|
||
<ul class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.HEALTHY">
|
||
<code class="sig-name descname">HEALTHY</code><em class="property"> = ClusterState(string='HEALTHY')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.ISOLATED">
|
||
<code class="sig-name descname">ISOLATED</code><em class="property"> = ClusterState(string='ISOLATED')</em><a class="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
|
||
added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState">
|
||
<em class="property">class </em><code class="sig-name descname">ConfigState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ConfigState</span></code> class defines the VCHA configuration state.
|
||
This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigState</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.CONFIGURED">
|
||
<code class="sig-name descname">CONFIGURED</code><em class="property"> = ConfigState(string='CONFIGURED')</em><a class="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
|
||
6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.INVALID">
|
||
<code class="sig-name descname">INVALID</code><em class="property"> = ConfigState(string='INVALID')</em><a class="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
|
||
in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.NOTCONFIGURED">
|
||
<code class="sig-name descname">NOTCONFIGURED</code><em class="property"> = ConfigState(string='NOTCONFIGURED')</em><a class="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
|
||
API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.PREPARED">
|
||
<code class="sig-name descname">PREPARED</code><em class="property"> = ConfigState(string='PREPARED')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.DeploySpec">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">deployment=None</em>, <em class="sig-param">active=None</em>, <em class="sig-param">passive=None</em>, <em class="sig-param">witness=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.DeploySpec</span></code> class contains the deploy specification for the
|
||
three nodes of a VCHA cluster. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Type" title="com.vmware.vcenter.vcha_client.Cluster.Type"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec" title="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec" title="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec" title="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.WitnessSpec</span></code></a>) – Contains the witness node’s placement configuration. This attribute
|
||
was added in vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition">
|
||
<em class="property">class </em><code class="sig-name descname">ErrorCondition</code><span class="sig-paren">(</span><em class="sig-param">error=None</em>, <em class="sig-param">recommendation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ErrorCondition</span></code> class contains an error condition and a
|
||
recommendation to handle the error condition. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>error</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Contains an error condition. This attribute was added in vSphere
|
||
API 6.7.1.</p></li>
|
||
<li><p><strong>recommendation</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">config_state=None</em>, <em class="sig-param">node1=None</em>, <em class="sig-param">node2=None</em>, <em class="sig-param">witness=None</em>, <em class="sig-param">mode=None</em>, <em class="sig-param">health_state=None</em>, <em class="sig-param">health_exception=None</em>, <em class="sig-param">health_warnings=None</em>, <em class="sig-param">manual_failover_allowed=None</em>, <em class="sig-param">auto_failover_allowed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Info</span></code> class contains the configuration and health
|
||
information of the three nodes in a VCHA Cluster. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>config_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState" title="com.vmware.vcenter.vcha_client.Cluster.ConfigState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ConfigState</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo" title="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.WitnessInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode" title="com.vmware.vcenter.vcha_client.Cluster.ClusterMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ClusterMode</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState" title="com.vmware.vcenter.vcha_client.Cluster.ClusterState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ClusterState</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition" title="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ErrorCondition</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily">
|
||
<em class="property">class </em><code class="sig-name descname">IpFamily</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.IpFamily</span></code> class defines the IP address family. This
|
||
enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpFamily</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4">
|
||
<code class="sig-name descname">IPV4</code><em class="property"> = IpFamily(string='IPV4')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6">
|
||
<code class="sig-name descname">IPV6</code><em class="property"> = IpFamily(string='IPV6')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpInfo">
|
||
<em class="property">class </em><code class="sig-name descname">IpInfo</code><span class="sig-paren">(</span><em class="sig-param">ip_family=None</em>, <em class="sig-param">ipv4=None</em>, <em class="sig-param">ipv6=None</em>, <em class="sig-param">gateway_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code> class contains attributes related to an ip. This
|
||
class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ip_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info" title="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.IpFamily.IPV4</span></code></a>.</p></li>
|
||
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info" title="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.IpFamily.IPV6</span></code></a>.</p></li>
|
||
<li><p><strong>gateway_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Gateway IP address. This attribute was added in vSphere API 6.7.1.
|
||
If None, no gateway is specified.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info">
|
||
<em class="property">class </em><code class="sig-name descname">Ipv4Info</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">subnet_mask=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Ipv4Info</span></code> class contains attributes to describe IPV4
|
||
information of the configured network interface. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info">
|
||
<em class="property">class </em><code class="sig-name descname">Ipv6Info</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Ipv6Info</span></code> class contains attributes to describe IPV6
|
||
information of the configured network interface. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The CIDR prefix of the interface. This attribute was added in
|
||
vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeInfo">
|
||
<em class="property">class </em><code class="sig-name descname">NodeInfo</code><span class="sig-paren">(</span><em class="sig-param">failover_ip=None</em>, <em class="sig-param">ha_ip=None</em>, <em class="sig-param">runtime=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code> class defines the configuration information for
|
||
the active and passive nodes in the cluster. This class was added in
|
||
vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>failover_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeInfo.ha_ip</span></code>. This
|
||
attribute was added in vSphere API 6.7.1.</p></li>
|
||
<li><p><strong>runtime</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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
|
||
node is not cloned yet.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole">
|
||
<em class="property">class </em><code class="sig-name descname">NodeRole</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeRole</span></code> class defines the role node can be in a VCHA
|
||
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NodeRole</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.ACTIVE">
|
||
<code class="sig-name descname">ACTIVE</code><em class="property"> = NodeRole(string='ACTIVE')</em><a class="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
|
||
6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.PASSIVE">
|
||
<code class="sig-name descname">PASSIVE</code><em class="property"> = NodeRole(string='PASSIVE')</em><a class="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
|
||
added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.WITNESS">
|
||
<code class="sig-name descname">WITNESS</code><em class="property"> = NodeRole(string='WITNESS')</em><a class="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
|
||
added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo">
|
||
<em class="property">class </em><code class="sig-name descname">NodeRuntimeInfo</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">role=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState" title="com.vmware.vcenter.vcha_client.Cluster.NodeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Last known state of the node.
|
||
The active node’s management vCenter server credentials are not
|
||
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole" title="com.vmware.vcenter.vcha_client.Cluster.NodeRole"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRole</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Last known role of the node.
|
||
The active node’s management vCenter server credentials are not
|
||
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementInfo" title="com.vmware.vcenter.vcha_client.PlacementInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Placement information of the node.
|
||
The active node’s management vCenter server credentials are
|
||
required to populate most attributes of
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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
|
||
fashion.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState">
|
||
<em class="property">class </em><code class="sig-name descname">NodeState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeState</span></code> class defines possible state a node can be in a
|
||
VCHA Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NodeState</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState.DOWN">
|
||
<code class="sig-name descname">DOWN</code><em class="property"> = NodeState(string='DOWN')</em><a class="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
|
||
in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState.UP">
|
||
<code class="sig-name descname">UP</code><em class="property"> = NodeState(string='UP')</em><a class="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
|
||
in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo">
|
||
<em class="property">class </em><code class="sig-name descname">NodeVmInfo</code><span class="sig-paren">(</span><em class="sig-param">vm=None</em>, <em class="sig-param">bios_uuid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">VirtualMachine:VCenter</span></code>.</p></li>
|
||
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
|
||
6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec">
|
||
<em class="property">class </em><code class="sig-name descname">PassiveSpec</code><span class="sig-paren">(</span><em class="sig-param">placement=None</em>, <em class="sig-param">ha_ip=None</em>, <em class="sig-param">failover_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
||
vCenter Server.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Type</span></code> class defines the possible deployment types for a VCHA
|
||
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type.AUTO">
|
||
<code class="sig-name descname">AUTO</code><em class="property"> = Type(string='AUTO')</em><a class="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
|
||
was added in vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type.MANUAL">
|
||
<code class="sig-name descname">MANUAL</code><em class="property"> = Type(string='MANUAL')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec">
|
||
<em class="property">class </em><code class="sig-name descname">UndeploySpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">force_delete=None</em>, <em class="sig-param">vms=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.UndeploySpec</span></code> class contains the undeploy specification for
|
||
a VCHA cluster. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <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 <code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
<li><p>If false, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
|
||
the information identifying the passive and witness virtual
|
||
machines.</p></li>
|
||
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
|
||
the information identifying the passive and witness virtual
|
||
machines.</p>
|
||
<ul>
|
||
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo" title="com.vmware.vcenter.vcha_client.Cluster.VmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.VmInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
|
||
controls whether this information is validated.</p>
|
||
<ul>
|
||
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
|
||
controls the deletion of the passive and witness virtual machines.</p>
|
||
<ul>
|
||
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.VmInfo">
|
||
<em class="property">class </em><code class="sig-name descname">VmInfo</code><span class="sig-paren">(</span><em class="sig-param">passive=None</em>, <em class="sig-param">witness=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>passive</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeVmInfo</span></code></a>) – The virtual machine information of the witness node. This attribute
|
||
was added in vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo">
|
||
<em class="property">class </em><code class="sig-name descname">WitnessInfo</code><span class="sig-paren">(</span><em class="sig-param">ha_ip=None</em>, <em class="sig-param">runtime=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.WitnessInfo.ha_ip</span></code>. This
|
||
attribute was added in vSphere API 6.7.1.</p></li>
|
||
<li><p><strong>runtime</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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
|
||
cloned yet.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec">
|
||
<em class="property">class </em><code class="sig-name descname">WitnessSpec</code><span class="sig-paren">(</span><em class="sig-param">placement=None</em>, <em class="sig-param">ha_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
|
||
vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.deploy_task">
|
||
<code class="sig-name descname">deploy_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec" title="com.vmware.vcenter.vcha_client.Cluster.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.DeploySpec</span></code></a>) – Contains the deploy specification for all three nodes of a VCHA
|
||
cluster.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If the credentials provided for authenticating with the active
|
||
node’s management vCenter server are invalid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user has insufficient privilege to perform the operation.
|
||
Operation execution requires the Global.VCServer privilege.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
|
||
If the SSL certificate of the management vCenter server cannot be
|
||
validated.
|
||
The value of the data attribute of
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
|
||
that contains all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If any other error occurs.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.failover_task">
|
||
<code class="sig-name descname">failover_task</code><span class="sig-paren">(</span><em class="sig-param">planned</em><span class="sig-paren">)</span><a class="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>
|
||
<ol class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>planned</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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
|
||
state to Passive and there is no data loss.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user has insufficient privilege to perform the operation.
|
||
Operation execution requires the Global.VCServer privilege.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If any other error occurs.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">partial=None</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <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>
|
||
</div></blockquote>
|
||
<p>If None, then return all the information.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Info" title="com.vmware.vcenter.vcha_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Info structure containing the VCHA configuration and health
|
||
information.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If the credentials provided for authenticating with the active
|
||
node’s management vCenter server are invalid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user has insufficient privilege to perform the operation.</p>
|
||
<ul class="simple">
|
||
<li><p>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is false or unset, then the operation execution
|
||
requires the Global.VCServer privilege.</p></li>
|
||
<li><p>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is true, then the operation execution requires the
|
||
System.Read privilege.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
|
||
If the SSL certificate of the management vCenter server cannot be
|
||
validated.
|
||
The value of the data attribute of
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
|
||
that contains all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If any other error occurs.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vcha_client.Cluster.undeploy_task">
|
||
<code class="sig-name descname">undeploy_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec" title="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.UndeploySpec</span></code></a>) – Contains the undeploy specification for a VCHA cluster.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If the credentials provided for authenticating with the active
|
||
node’s management vCenter server are invalid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If the passive virtual machine is not managed by the specified
|
||
vCenter server.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If the witness virtual machine is not managed by the specified
|
||
vCenter server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user has insufficient privilege to perform the operation.
|
||
Operation execution requires the Global.VCServer privilege.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
|
||
If the SSL certificate of the management vCenter server cannot be
|
||
validated.
|
||
The value of the data attribute of
|
||
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
|
||
that contains all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If any other error occurs.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.ConnectionSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">ConnectionSpec</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.ConnectionSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionSpec</span></code> class contains information required to connect to a
|
||
vCenter server. The connection to the vCenter server always uses the HTTPS
|
||
protocol. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP Address or DNS of the vCenter. This attribute was added in
|
||
vSphere API 6.7.1.</p></li>
|
||
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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,
|
||
then the requested operation will fail.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.CredentialsSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">CredentialsSpec</code><span class="sig-paren">(</span><em class="sig-param">active_location=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CredentialsSpec</span></code> class contains information to connect to the
|
||
vCenter server managing the VCHA nodes. This class was added in vSphere API
|
||
6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>active_location</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.ConnectionSpec" title="com.vmware.vcenter.vcha_client.ConnectionSpec"><code class="xref py py-class docutils literal notranslate"><span class="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
|
||
API 6.7.1.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.DiskInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">DiskInfo</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">datastore_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.DiskInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DiskInfo</span></code> class contains information to describe the storage
|
||
configuration of a vCenter virtual machine. This class was added in vSphere
|
||
API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the datastore to put all the virtual disks on.
|
||
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:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore: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: <code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>.</p></li>
|
||
<li><p><strong>datastore_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the datastore. This attribute was added in vSphere API
|
||
6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.DiskSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">DiskSpec</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.DiskSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">DiskSpec</span></code> class contains information to describe the storage
|
||
configuration of a vCenter virtual machine. This class was added in vSphere
|
||
API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of the datastore to put all the virtual disks on.
|
||
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:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore: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: <code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>.
|
||
This field needs to be set. If None, then see
|
||
vim.vm.RelocateSpec.datastore.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.IpFamily">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">IpFamily</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpFamily" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpFamily</span></code> class defines the Ip address family. This enumeration was
|
||
added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpFamily</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.IpFamily.IPV4">
|
||
<code class="sig-name descname">IPV4</code><em class="property"> = IpFamily(string='IPV4')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.IpFamily.IPV6">
|
||
<code class="sig-name descname">IPV6</code><em class="property"> = IpFamily(string='IPV6')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.IpSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">IpSpec</code><span class="sig-paren">(</span><em class="sig-param">ip_family=None</em>, <em class="sig-param">ipv4=None</em>, <em class="sig-param">ipv6=None</em>, <em class="sig-param">default_gateway=None</em>, <em class="sig-param">dns_servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">IpSpec</span></code> class contains IP information used to configure a network
|
||
interface. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ip_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Ipv4Spec" title="com.vmware.vcenter.vcha_client.Ipv4Spec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4" title="com.vmware.vcenter.vcha_client.IpFamily.IPV4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IpFamily.IPV4</span></code></a>.</p></li>
|
||
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Ipv6Spec" title="com.vmware.vcenter.vcha_client.Ipv6Spec"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6" title="com.vmware.vcenter.vcha_client.IpFamily.IPV6"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IpFamily.IPV6</span></code></a>.</p></li>
|
||
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Ipv4Spec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">Ipv4Spec</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">subnet_mask=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Ipv4Spec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4Spec</span></code> class contains IPV4 information used to configure a
|
||
network interface. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The subnet mask for the interface. This attribute was added in
|
||
vSphere API 6.7.1.
|
||
If None and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute is None, then an error will be
|
||
reported.
|
||
If None and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute is set, then the <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute and the <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The CIDR prefix for the interface. This attribute was added in
|
||
vSphere API 6.7.1.
|
||
If None and the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute is None, this an error
|
||
will be reported.
|
||
If None and the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute is set, then the
|
||
<code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute will be used.
|
||
If both the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute
|
||
are set and they do not represent the same value, then an error
|
||
will be reported.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Ipv6Spec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">Ipv6Spec</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Ipv6Spec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6Spec</span></code> class contains IPV6 information used to configure a
|
||
network interface. This class was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The CIDR prefix for the interface. This attribute was added in
|
||
vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.NetworkType">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">NetworkType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.NetworkType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">NetworkType</span></code> class defines the type of a vCenter Server network.
|
||
This enumeration was added in vSphere API 6.7.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.NetworkType.DISTRIBUTED_PORTGROUP">
|
||
<code class="sig-name descname">DISTRIBUTED_PORTGROUP</code><em class="property"> = NetworkType(string='DISTRIBUTED_PORTGROUP')</em><a class="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
|
||
6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.NetworkType.STANDARD_PORTGROUP">
|
||
<code class="sig-name descname">STANDARD_PORTGROUP</code><em class="property"> = NetworkType(string='STANDARD_PORTGROUP')</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">Operations</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP">
|
||
<code class="sig-name descname">CLUSTER_DEPLOY_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.deploy'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP">
|
||
<code class="sig-name descname">CLUSTER_FAILOVER_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.failover'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP">
|
||
<code class="sig-name descname">CLUSTER_GET_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.get'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP">
|
||
<code class="sig-name descname">CLUSTER_UNDEPLOY_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.undeploy'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">disabled=None</em>, <em class="sig-param">active=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Operations.Info</span></code> class contains information about which the VCHA
|
||
operations cannot be invoked in the current state of the system and the
|
||
list of currently active VCHA operations. This class was added in vSphere
|
||
API 6.7.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>disabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of the operations that are current disabled. These
|
||
operation strings are one of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_FAILOVER_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.PASSIVE_REDEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.WITNESS_REDEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP" title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.MODE_SET_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a> and
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of the operations that are currently running. These
|
||
operation strings are one of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_FAILOVER_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.PASSIVE_REDEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.WITNESS_REDEPLOY_OP</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP" title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.MODE_SET_OP</span></code></a>, and
|
||
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.MODE_GET_OP">
|
||
<code class="sig-name descname">MODE_GET_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.mode.get'</em><a class="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
|
||
API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP">
|
||
<code class="sig-name descname">MODE_SET_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.mode.set'</em><a class="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
|
||
API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP">
|
||
<code class="sig-name descname">PASSIVE_REDEPLOY_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.passive.redeploy'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP">
|
||
<code class="sig-name descname">WITNESS_REDEPLOY_OP</code><em class="property"> = 'com.vmware.vcenter.vcha.cluster.witness.redeploy'</em><a class="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
|
||
vSphere API 6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vcha_client.Operations.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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.
|
||
This method was added in vSphere API 6.7.1.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.Info" title="com.vmware.vcenter.vcha_client.Operations.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operations.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Info structure containing the current running and disabled
|
||
operations of a VCHA cluster.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the user has insufficient privilege to perform the operation.
|
||
Operation execution requires the System.Read privilege.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If any other error occurs.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.PlacementInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">PlacementInfo</code><span class="sig-paren">(</span><em class="sig-param">management_vcenter_name=None</em>, <em class="sig-param">vm_name=None</em>, <em class="sig-param">datacenter=None</em>, <em class="sig-param">datacenter_name=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">host_name=None</em>, <em class="sig-param">cluster=None</em>, <em class="sig-param">cluster_name=None</em>, <em class="sig-param">ha_network=None</em>, <em class="sig-param">ha_network_name=None</em>, <em class="sig-param">ha_network_type=None</em>, <em class="sig-param">management_network=None</em>, <em class="sig-param">management_network_name=None</em>, <em class="sig-param">management_network_type=None</em>, <em class="sig-param">storage=None</em>, <em class="sig-param">bios_uuid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.PlacementInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>management_vcenter_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter:VCenter</span></code>.</p></li>
|
||
<li><p><strong>datacenter_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>.</p></li>
|
||
<li><p><strong>host_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of the cluster of which <code class="docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource:VCenter</span></code>.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">host</span></code> is a standalone host.</p></li>
|
||
<li><p><strong>cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The name of the cluster of which <code class="docutils literal notranslate"><span class="pre">host</span></code> is member. This attribute
|
||
was added in vSphere API 6.7.1.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">host</span></code> is a standalone host.</p></li>
|
||
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
|
||
If None, the information is currently unavailable or the haNetwork
|
||
is not configured.</p></li>
|
||
<li><p><strong>ha_network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The 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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.</p></li>
|
||
<li><p><strong>management_network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.DiskInfo" title="com.vmware.vcenter.vcha_client.DiskInfo"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
|
||
6.7.1.
|
||
If None, the information is currently unavailable.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.PlacementSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">PlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">folder=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">ha_network_type=None</em>, <em class="sig-param">ha_network=None</em>, <em class="sig-param">management_network_type=None</em>, <em class="sig-param">management_network=None</em>, <em class="sig-param">storage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the 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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Folder:VCenter</span></code>.</p></li>
|
||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>.
|
||
If None, see vim.vm.RelocateSpec.host.</p></li>
|
||
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of 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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool:VCenter</span></code>.
|
||
If None, then the active node’s resource pool will be used.</p></li>
|
||
<li><p><strong>ha_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of the Network object used by the HA network.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> field must be set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
|
||
attribute was added in vSphere API 6.7.1.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set,
|
||
then an error is reported.</p></li>
|
||
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of the Network object used for the HA network.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
|
||
{#link #haNetworkType} attribute must be set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of the Network object used by the Management network.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is set,
|
||
then the {#link #managementNetworkType} field must be set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is None,
|
||
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code> attribute is
|
||
ignored. This attribute was added in vSphere API 6.7.1.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute
|
||
is set, then an error is reported.</p></li>
|
||
<li><p><strong>management_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The identifier of the Network object used for the Management
|
||
network. If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute
|
||
is set, then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code>
|
||
attribute must be set.
|
||
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is None,
|
||
then the <code class="xref py py-attr docutils literal notranslate"><span class="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:
|
||
<code class="docutils literal notranslate"><span class="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
|
||
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
|
||
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.DiskSpec" title="com.vmware.vcenter.vcha_client.DiskSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vcha_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.vm_client">
|
||
<span id="com-vmware-vcenter-vm-client-module"></span><h2>com.vmware.vcenter.vm_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
|
||
virtual machines.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">GuestOS</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">GuestOS</span></code> class defines the valid guest operating system types used
|
||
for configuring a virtual machine.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuestOS</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX2_64">
|
||
<code class="sig-name descname">AMAZONLINUX2_64</code><em class="property"> = GuestOS(string='AMAZONLINUX2_64')</em><a class="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
|
||
6.7.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3">
|
||
<code class="sig-name descname">ASIANUX_3</code><em class="property"> = GuestOS(string='ASIANUX_3')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 3</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64">
|
||
<code class="sig-name descname">ASIANUX_3_64</code><em class="property"> = GuestOS(string='ASIANUX_3_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 3 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4">
|
||
<code class="sig-name descname">ASIANUX_4</code><em class="property"> = GuestOS(string='ASIANUX_4')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64">
|
||
<code class="sig-name descname">ASIANUX_4_64</code><em class="property"> = GuestOS(string='ASIANUX_4_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 4 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64">
|
||
<code class="sig-name descname">ASIANUX_5_64</code><em class="property"> = GuestOS(string='ASIANUX_5_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 5 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64">
|
||
<code class="sig-name descname">ASIANUX_7_64</code><em class="property"> = GuestOS(string='ASIANUX_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Asianux Server 7 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_8_64">
|
||
<code class="sig-name descname">ASIANUX_8_64</code><em class="property"> = GuestOS(string='ASIANUX_8_64')</em><a class="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
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS">
|
||
<code class="sig-name descname">CENTOS</code><em class="property"> = GuestOS(string='CENTOS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 4/5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_6">
|
||
<code class="sig-name descname">CENTOS_6</code><em class="property"> = GuestOS(string='CENTOS_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_64">
|
||
<code class="sig-name descname">CENTOS_64</code><em class="property"> = GuestOS(string='CENTOS_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 4/5 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64">
|
||
<code class="sig-name descname">CENTOS_6_64</code><em class="property"> = GuestOS(string='CENTOS_6_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 6 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_7">
|
||
<code class="sig-name descname">CENTOS_7</code><em class="property"> = GuestOS(string='CENTOS_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64">
|
||
<code class="sig-name descname">CENTOS_7_64</code><em class="property"> = GuestOS(string='CENTOS_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 7 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64">
|
||
<code class="sig-name descname">CENTOS_8_64</code><em class="property"> = GuestOS(string='CENTOS_8_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CentOS 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.COREOS_64">
|
||
<code class="sig-name descname">COREOS_64</code><em class="property"> = GuestOS(string='COREOS_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.COREOS_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CoreOS Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN">
|
||
<code class="sig-name descname">DARWIN</code><em class="property"> = GuestOS(string='DARWIN')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_10">
|
||
<code class="sig-name descname">DARWIN_10</code><em class="property"> = GuestOS(string='DARWIN_10')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64">
|
||
<code class="sig-name descname">DARWIN_10_64</code><em class="property"> = GuestOS(string='DARWIN_10_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.6 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_11">
|
||
<code class="sig-name descname">DARWIN_11</code><em class="property"> = GuestOS(string='DARWIN_11')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64">
|
||
<code class="sig-name descname">DARWIN_11_64</code><em class="property"> = GuestOS(string='DARWIN_11_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.7 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64">
|
||
<code class="sig-name descname">DARWIN_12_64</code><em class="property"> = GuestOS(string='DARWIN_12_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.8 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64">
|
||
<code class="sig-name descname">DARWIN_13_64</code><em class="property"> = GuestOS(string='DARWIN_13_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.9 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64">
|
||
<code class="sig-name descname">DARWIN_14_64</code><em class="property"> = GuestOS(string='DARWIN_14_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.10 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64">
|
||
<code class="sig-name descname">DARWIN_15_64</code><em class="property"> = GuestOS(string='DARWIN_15_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.11 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64">
|
||
<code class="sig-name descname">DARWIN_16_64</code><em class="property"> = GuestOS(string='DARWIN_16_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.12 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64">
|
||
<code class="sig-name descname">DARWIN_17_64</code><em class="property"> = GuestOS(string='DARWIN_17_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.13 (64 bit). This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64">
|
||
<code class="sig-name descname">DARWIN_18_64</code><em class="property"> = GuestOS(string='DARWIN_18_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.14 (64 bit). This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_64">
|
||
<code class="sig-name descname">DARWIN_64</code><em class="property"> = GuestOS(string='DARWIN_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS 10.5 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10">
|
||
<code class="sig-name descname">DEBIAN_10</code><em class="property"> = GuestOS(string='DEBIAN_10')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 10</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64">
|
||
<code class="sig-name descname">DEBIAN_10_64</code><em class="property"> = GuestOS(string='DEBIAN_10_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 10 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4">
|
||
<code class="sig-name descname">DEBIAN_4</code><em class="property"> = GuestOS(string='DEBIAN_4')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64">
|
||
<code class="sig-name descname">DEBIAN_4_64</code><em class="property"> = GuestOS(string='DEBIAN_4_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 4 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5">
|
||
<code class="sig-name descname">DEBIAN_5</code><em class="property"> = GuestOS(string='DEBIAN_5')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64">
|
||
<code class="sig-name descname">DEBIAN_5_64</code><em class="property"> = GuestOS(string='DEBIAN_5_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 5 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6">
|
||
<code class="sig-name descname">DEBIAN_6</code><em class="property"> = GuestOS(string='DEBIAN_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64">
|
||
<code class="sig-name descname">DEBIAN_6_64</code><em class="property"> = GuestOS(string='DEBIAN_6_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 6 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7">
|
||
<code class="sig-name descname">DEBIAN_7</code><em class="property"> = GuestOS(string='DEBIAN_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64">
|
||
<code class="sig-name descname">DEBIAN_7_64</code><em class="property"> = GuestOS(string='DEBIAN_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 7 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8">
|
||
<code class="sig-name descname">DEBIAN_8</code><em class="property"> = GuestOS(string='DEBIAN_8')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 8</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64">
|
||
<code class="sig-name descname">DEBIAN_8_64</code><em class="property"> = GuestOS(string='DEBIAN_8_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 8 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9">
|
||
<code class="sig-name descname">DEBIAN_9</code><em class="property"> = GuestOS(string='DEBIAN_9')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debian GNU/Linux 9</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9_64">
|
||
<code class="sig-name descname">DEBIAN_9_64</code><em class="property"> = GuestOS(string='DEBIAN_9_64')</em><a class="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>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.DOS">
|
||
<code class="sig-name descname">DOS</code><em class="property"> = GuestOS(string='DOS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DOS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>MS-DOS.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION">
|
||
<code class="sig-name descname">ECOMSTATION</code><em class="property"> = GuestOS(string='ECOMSTATION')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>eComStation 1.x</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2">
|
||
<code class="sig-name descname">ECOMSTATION_2</code><em class="property"> = GuestOS(string='ECOMSTATION_2')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>eComStation 2.0</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FEDORA">
|
||
<code class="sig-name descname">FEDORA</code><em class="property"> = GuestOS(string='FEDORA')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fedora Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FEDORA_64">
|
||
<code class="sig-name descname">FEDORA_64</code><em class="property"> = GuestOS(string='FEDORA_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fedora Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD">
|
||
<code class="sig-name descname">FREEBSD</code><em class="property"> = GuestOS(string='FREEBSD')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 10 or earlier</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11">
|
||
<code class="sig-name descname">FREEBSD_11</code><em class="property"> = GuestOS(string='FREEBSD_11')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 11. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64">
|
||
<code class="sig-name descname">FREEBSD_11_64</code><em class="property"> = GuestOS(string='FREEBSD_11_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 11 x64. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12">
|
||
<code class="sig-name descname">FREEBSD_12</code><em class="property"> = GuestOS(string='FREEBSD_12')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 12 or later. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64">
|
||
<code class="sig-name descname">FREEBSD_12_64</code><em class="property"> = GuestOS(string='FREEBSD_12_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 12 x64 or later. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64">
|
||
<code class="sig-name descname">FREEBSD_64</code><em class="property"> = GuestOS(string='FREEBSD_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>FreeBSD 10 x64 or earlier</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX">
|
||
<code class="sig-name descname">GENERIC_LINUX</code><em class="property"> = GuestOS(string='GENERIC_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Other Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRAKE">
|
||
<code class="sig-name descname">MANDRAKE</code><em class="property"> = GuestOS(string='MANDRAKE')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRAKE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mandrake Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRIVA">
|
||
<code class="sig-name descname">MANDRIVA</code><em class="property"> = GuestOS(string='MANDRIVA')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mandriva Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64">
|
||
<code class="sig-name descname">MANDRIVA_64</code><em class="property"> = GuestOS(string='MANDRIVA_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mandriva Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_4">
|
||
<code class="sig-name descname">NETWARE_4</code><em class="property"> = GuestOS(string='NETWARE_4')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Novell NetWare 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_5">
|
||
<code class="sig-name descname">NETWARE_5</code><em class="property"> = GuestOS(string='NETWARE_5')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Novell NetWare 5.1</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_6">
|
||
<code class="sig-name descname">NETWARE_6</code><em class="property"> = GuestOS(string='NETWARE_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Novell NetWare 6.x</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.NLD_9">
|
||
<code class="sig-name descname">NLD_9</code><em class="property"> = GuestOS(string='NLD_9')</em><a class="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>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OES">
|
||
<code class="sig-name descname">OES</code><em class="property"> = GuestOS(string='OES')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OES" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Open Enterprise Server</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5">
|
||
<code class="sig-name descname">OPENSERVER_5</code><em class="property"> = GuestOS(string='OPENSERVER_5')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>SCO OpenServer 5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6">
|
||
<code class="sig-name descname">OPENSERVER_6</code><em class="property"> = GuestOS(string='OPENSERVER_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>SCO OpenServer 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSUSE">
|
||
<code class="sig-name descname">OPENSUSE</code><em class="property"> = GuestOS(string='OPENSUSE')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>OpenSUSE Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64">
|
||
<code class="sig-name descname">OPENSUSE_64</code><em class="property"> = GuestOS(string='OPENSUSE_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>OpenSUSE Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX">
|
||
<code class="sig-name descname">ORACLE_LINUX</code><em class="property"> = GuestOS(string='ORACLE_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 4/5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6">
|
||
<code class="sig-name descname">ORACLE_LINUX_6</code><em class="property"> = GuestOS(string='ORACLE_LINUX_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64">
|
||
<code class="sig-name descname">ORACLE_LINUX_64</code><em class="property"> = GuestOS(string='ORACLE_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 4/5 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64">
|
||
<code class="sig-name descname">ORACLE_LINUX_6_64</code><em class="property"> = GuestOS(string='ORACLE_LINUX_6_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 6 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7">
|
||
<code class="sig-name descname">ORACLE_LINUX_7</code><em class="property"> = GuestOS(string='ORACLE_LINUX_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64">
|
||
<code class="sig-name descname">ORACLE_LINUX_7_64</code><em class="property"> = GuestOS(string='ORACLE_LINUX_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 7 (64-bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64">
|
||
<code class="sig-name descname">ORACLE_LINUX_8_64</code><em class="property"> = GuestOS(string='ORACLE_LINUX_8_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Oracle Linux 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OS2">
|
||
<code class="sig-name descname">OS2</code><em class="property"> = GuestOS(string='OS2')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OS2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>OS/2</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER">
|
||
<code class="sig-name descname">OTHER</code><em class="property"> = GuestOS(string='OTHER')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Other Operating System</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX">
|
||
<code class="sig-name descname">OTHER_24X_LINUX</code><em class="property"> = GuestOS(string='OTHER_24X_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 2.4x Kernel</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64">
|
||
<code class="sig-name descname">OTHER_24X_LINUX_64</code><em class="property"> = GuestOS(string='OTHER_24X_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 2.4x Kernel (64 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX">
|
||
<code class="sig-name descname">OTHER_26X_LINUX</code><em class="property"> = GuestOS(string='OTHER_26X_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 2.6x Kernel</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64">
|
||
<code class="sig-name descname">OTHER_26X_LINUX_64</code><em class="property"> = GuestOS(string='OTHER_26X_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 2.6x Kernel (64 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX">
|
||
<code class="sig-name descname">OTHER_3X_LINUX</code><em class="property"> = GuestOS(string='OTHER_3X_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 3.x Kernel</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64">
|
||
<code class="sig-name descname">OTHER_3X_LINUX_64</code><em class="property"> = GuestOS(string='OTHER_3X_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 3.x Kernel (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX">
|
||
<code class="sig-name descname">OTHER_4X_LINUX</code><em class="property"> = GuestOS(string='OTHER_4X_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 4.x Kernel. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX_64">
|
||
<code class="sig-name descname">OTHER_4X_LINUX_64</code><em class="property"> = GuestOS(string='OTHER_4X_LINUX_64')</em><a class="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
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_64">
|
||
<code class="sig-name descname">OTHER_64</code><em class="property"> = GuestOS(string='OTHER_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX">
|
||
<code class="sig-name descname">OTHER_LINUX</code><em class="property"> = GuestOS(string='OTHER_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux 2.2x Kernel</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64">
|
||
<code class="sig-name descname">OTHER_LINUX_64</code><em class="property"> = GuestOS(string='OTHER_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux (64 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.REDHAT">
|
||
<code class="sig-name descname">REDHAT</code><em class="property"> = GuestOS(string='REDHAT')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.REDHAT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Linux 2.1</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_2">
|
||
<code class="sig-name descname">RHEL_2</code><em class="property"> = GuestOS(string='RHEL_2')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 2</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_3">
|
||
<code class="sig-name descname">RHEL_3</code><em class="property"> = GuestOS(string='RHEL_3')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 3</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64">
|
||
<code class="sig-name descname">RHEL_3_64</code><em class="property"> = GuestOS(string='RHEL_3_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 3 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_4">
|
||
<code class="sig-name descname">RHEL_4</code><em class="property"> = GuestOS(string='RHEL_4')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64">
|
||
<code class="sig-name descname">RHEL_4_64</code><em class="property"> = GuestOS(string='RHEL_4_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 4 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_5">
|
||
<code class="sig-name descname">RHEL_5</code><em class="property"> = GuestOS(string='RHEL_5')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_5_64">
|
||
<code class="sig-name descname">RHEL_5_64</code><em class="property"> = GuestOS(string='RHEL_5_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_6">
|
||
<code class="sig-name descname">RHEL_6</code><em class="property"> = GuestOS(string='RHEL_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64">
|
||
<code class="sig-name descname">RHEL_6_64</code><em class="property"> = GuestOS(string='RHEL_6_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 6 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_7">
|
||
<code class="sig-name descname">RHEL_7</code><em class="property"> = GuestOS(string='RHEL_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64">
|
||
<code class="sig-name descname">RHEL_7_64</code><em class="property"> = GuestOS(string='RHEL_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Red Hat Enterprise Linux 7 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_8_64">
|
||
<code class="sig-name descname">RHEL_8_64</code><em class="property"> = GuestOS(string='RHEL_8_64')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SJDS">
|
||
<code class="sig-name descname">SJDS</code><em class="property"> = GuestOS(string='SJDS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SJDS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sun Java Desktop System</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES">
|
||
<code class="sig-name descname">SLES</code><em class="property"> = GuestOS(string='SLES')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse Linux Enterprise Server 9</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_10">
|
||
<code class="sig-name descname">SLES_10</code><em class="property"> = GuestOS(string='SLES_10')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse linux Enterprise Server 10</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_10_64">
|
||
<code class="sig-name descname">SLES_10_64</code><em class="property"> = GuestOS(string='SLES_10_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_11">
|
||
<code class="sig-name descname">SLES_11</code><em class="property"> = GuestOS(string='SLES_11')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse linux Enterprise Server 11</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_11_64">
|
||
<code class="sig-name descname">SLES_11_64</code><em class="property"> = GuestOS(string='SLES_11_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_12">
|
||
<code class="sig-name descname">SLES_12</code><em class="property"> = GuestOS(string='SLES_12')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse linux Enterprise Server 12</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_12_64">
|
||
<code class="sig-name descname">SLES_12_64</code><em class="property"> = GuestOS(string='SLES_12_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_15_64">
|
||
<code class="sig-name descname">SLES_15_64</code><em class="property"> = GuestOS(string='SLES_15_64')</em><a class="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
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_64">
|
||
<code class="sig-name descname">SLES_64</code><em class="property"> = GuestOS(string='SLES_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10">
|
||
<code class="sig-name descname">SOLARIS_10</code><em class="property"> = GuestOS(string='SOLARIS_10')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 10 (32 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64">
|
||
<code class="sig-name descname">SOLARIS_10_64</code><em class="property"> = GuestOS(string='SOLARIS_10_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 10 (64 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64">
|
||
<code class="sig-name descname">SOLARIS_11_64</code><em class="property"> = GuestOS(string='SOLARIS_11_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 11 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6">
|
||
<code class="sig-name descname">SOLARIS_6</code><em class="property"> = GuestOS(string='SOLARIS_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7">
|
||
<code class="sig-name descname">SOLARIS_7</code><em class="property"> = GuestOS(string='SOLARIS_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8">
|
||
<code class="sig-name descname">SOLARIS_8</code><em class="property"> = GuestOS(string='SOLARIS_8')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 8</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9">
|
||
<code class="sig-name descname">SOLARIS_9</code><em class="property"> = GuestOS(string='SOLARIS_9')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris 9</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SUSE">
|
||
<code class="sig-name descname">SUSE</code><em class="property"> = GuestOS(string='SUSE')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SUSE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.SUSE_64">
|
||
<code class="sig-name descname">SUSE_64</code><em class="property"> = GuestOS(string='SUSE_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SUSE_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suse Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX">
|
||
<code class="sig-name descname">TURBO_LINUX</code><em class="property"> = GuestOS(string='TURBO_LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Turbolinux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64">
|
||
<code class="sig-name descname">TURBO_LINUX_64</code><em class="property"> = GuestOS(string='TURBO_LINUX_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Turbolinux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.UBUNTU">
|
||
<code class="sig-name descname">UBUNTU</code><em class="property"> = GuestOS(string='UBUNTU')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Ubuntu Linux</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64">
|
||
<code class="sig-name descname">UBUNTU_64</code><em class="property"> = GuestOS(string='UBUNTU_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Ubuntu Linux (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7">
|
||
<code class="sig-name descname">UNIXWARE_7</code><em class="property"> = GuestOS(string='UNIXWARE_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>SCO UnixWare 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL">
|
||
<code class="sig-name descname">VMKERNEL</code><em class="property"> = GuestOS(string='VMKERNEL')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>VMware ESX 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5">
|
||
<code class="sig-name descname">VMKERNEL_5</code><em class="property"> = GuestOS(string='VMKERNEL_5')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>VMware ESX 5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6">
|
||
<code class="sig-name descname">VMKERNEL_6</code><em class="property"> = GuestOS(string='VMKERNEL_6')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>VMware ESX 6</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65">
|
||
<code class="sig-name descname">VMKERNEL_65</code><em class="property"> = GuestOS(string='VMKERNEL_65')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>VMware ESX 6.5</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64">
|
||
<code class="sig-name descname">VMWARE_PHOTON_64</code><em class="property"> = GuestOS(string='VMWARE_PHOTON_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>VMware Photon (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7">
|
||
<code class="sig-name descname">WINDOWS_7</code><em class="property"> = GuestOS(string='WINDOWS_7')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 7</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64">
|
||
<code class="sig-name descname">WINDOWS_7_64</code><em class="property"> = GuestOS(string='WINDOWS_7_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 7 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64">
|
||
<code class="sig-name descname">WINDOWS_7_SERVER_64</code><em class="property"> = GuestOS(string='WINDOWS_7_SERVER_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Server 2008 R2 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8">
|
||
<code class="sig-name descname">WINDOWS_8</code><em class="property"> = GuestOS(string='WINDOWS_8')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 8</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64">
|
||
<code class="sig-name descname">WINDOWS_8_64</code><em class="property"> = GuestOS(string='WINDOWS_8_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 8 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64">
|
||
<code class="sig-name descname">WINDOWS_8_SERVER_64</code><em class="property"> = GuestOS(string='WINDOWS_8_SERVER_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 8 Server (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9">
|
||
<code class="sig-name descname">WINDOWS_9</code><em class="property"> = GuestOS(string='WINDOWS_9')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 10</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64">
|
||
<code class="sig-name descname">WINDOWS_9_64</code><em class="property"> = GuestOS(string='WINDOWS_9_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 10 (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64">
|
||
<code class="sig-name descname">WINDOWS_9_SERVER_64</code><em class="property"> = GuestOS(string='WINDOWS_9_SERVER_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 10 Server (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV">
|
||
<code class="sig-name descname">WINDOWS_HYPERV</code><em class="property"> = GuestOS(string='WINDOWS_HYPERV')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Hyper-V</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV">
|
||
<code class="sig-name descname">WIN_2000_ADV_SERV</code><em class="property"> = GuestOS(string='WIN_2000_ADV_SERV')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 2000 Advanced Server</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO">
|
||
<code class="sig-name descname">WIN_2000_PRO</code><em class="property"> = GuestOS(string='WIN_2000_PRO')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 2000 Professional</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV">
|
||
<code class="sig-name descname">WIN_2000_SERV</code><em class="property"> = GuestOS(string='WIN_2000_SERV')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 2000 Server</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_31">
|
||
<code class="sig-name descname">WIN_31</code><em class="property"> = GuestOS(string='WIN_31')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_31" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 3.1</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_95">
|
||
<code class="sig-name descname">WIN_95</code><em class="property"> = GuestOS(string='WIN_95')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_95" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 95</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_98">
|
||
<code class="sig-name descname">WIN_98</code><em class="property"> = GuestOS(string='WIN_98')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_98" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows 98</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN">
|
||
<code class="sig-name descname">WIN_LONGHORN</code><em class="property"> = GuestOS(string='WIN_LONGHORN')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Longhorn (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64">
|
||
<code class="sig-name descname">WIN_LONGHORN_64</code><em class="property"> = GuestOS(string='WIN_LONGHORN_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Longhorn (64 bit) (experimental)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_ME">
|
||
<code class="sig-name descname">WIN_ME</code><em class="property"> = GuestOS(string='WIN_ME')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_ME" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Millennium Edition</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS">
|
||
<code class="sig-name descname">WIN_NET_BUSINESS</code><em class="property"> = GuestOS(string='WIN_NET_BUSINESS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Small Business Server 2003</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER">
|
||
<code class="sig-name descname">WIN_NET_DATACENTER</code><em class="property"> = GuestOS(string='WIN_NET_DATACENTER')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER_64">
|
||
<code class="sig-name descname">WIN_NET_DATACENTER_64</code><em class="property"> = GuestOS(string='WIN_NET_DATACENTER_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE">
|
||
<code class="sig-name descname">WIN_NET_ENTERPRISE</code><em class="property"> = GuestOS(string='WIN_NET_ENTERPRISE')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE_64">
|
||
<code class="sig-name descname">WIN_NET_ENTERPRISE_64</code><em class="property"> = GuestOS(string='WIN_NET_ENTERPRISE_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD">
|
||
<code class="sig-name descname">WIN_NET_STANDARD</code><em class="property"> = GuestOS(string='WIN_NET_STANDARD')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Server 2003, Standard Edition</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD_64">
|
||
<code class="sig-name descname">WIN_NET_STANDARD_64</code><em class="property"> = GuestOS(string='WIN_NET_STANDARD_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB">
|
||
<code class="sig-name descname">WIN_NET_WEB</code><em class="property"> = GuestOS(string='WIN_NET_WEB')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Server 2003, Web Edition</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NT">
|
||
<code class="sig-name descname">WIN_NT</code><em class="property"> = GuestOS(string='WIN_NT')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows NT 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA">
|
||
<code class="sig-name descname">WIN_VISTA</code><em class="property"> = GuestOS(string='WIN_VISTA')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Vista</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64">
|
||
<code class="sig-name descname">WIN_VISTA_64</code><em class="property"> = GuestOS(string='WIN_VISTA_64')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows Vista (64 bit)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME">
|
||
<code class="sig-name descname">WIN_XP_HOME</code><em class="property"> = GuestOS(string='WIN_XP_HOME')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows XP Home Edition</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO">
|
||
<code class="sig-name descname">WIN_XP_PRO</code><em class="property"> = GuestOS(string='WIN_XP_PRO')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows XP Professional</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO_64">
|
||
<code class="sig-name descname">WIN_XP_PRO_64</code><em class="property"> = GuestOS(string='WIN_XP_PRO_64')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">GuestOSFamily</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">GuestOSFamily</span></code> class defines the valid guest operating system family
|
||
types reported by a virtual machine. This enumeration was added in vSphere
|
||
API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOSFamily" title="com.vmware.vcenter.vm_client.GuestOSFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuestOSFamily</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN">
|
||
<code class="sig-name descname">DARWIN</code><em class="property"> = GuestOSFamily(string='DARWIN')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mac OS operating system. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.LINUX">
|
||
<code class="sig-name descname">LINUX</code><em class="property"> = GuestOSFamily(string='LINUX')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.LINUX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Linux operating system. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE">
|
||
<code class="sig-name descname">NETWARE</code><em class="property"> = GuestOSFamily(string='NETWARE')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Novell Netware. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.OTHER">
|
||
<code class="sig-name descname">OTHER</code><em class="property"> = GuestOSFamily(string='OTHER')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.OTHER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Other operating systems. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS">
|
||
<code class="sig-name descname">SOLARIS</code><em class="property"> = GuestOSFamily(string='SOLARIS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solaris operating system. This class attribute was added in vSphere API
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS">
|
||
<code class="sig-name descname">WINDOWS</code><em class="property"> = GuestOSFamily(string='WINDOWS')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Windows operating system. This class attribute was added in vSphere API
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">Hardware</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware</span></code> class provides methods for configuring the virtual
|
||
hardware of a virtual machine.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">upgrade_policy=None</em>, <em class="sig-param">upgrade_version=None</em>, <em class="sig-param">upgrade_status=None</em>, <em class="sig-param">upgrade_error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.Info</span></code> class contains information related to the virtual
|
||
hardware of a virtual machine.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a>) – Virtual hardware version.</p></li>
|
||
<li><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code></a>) – Scheduled upgrade policy.</p></li>
|
||
<li><p><strong>upgrade_version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a>) – Target hardware version to be used on the next scheduled virtual
|
||
hardware upgrade.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">upgradePolicy</span></code> is one of
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.ALWAYS</span></code></a>.</p></li>
|
||
<li><p><strong>upgrade_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus" title="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus</span></code></a>) – Scheduled upgrade status.</p></li>
|
||
<li><p><strong>upgrade_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code>) – Reason for the scheduled upgrade failure.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">upgradeStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED" title="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus.FAILED</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">upgrade_policy=None</em>, <em class="sig-param">upgrade_version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpdateSpec</span></code> class describes the updates to virtual hardware
|
||
settings of a virtual machine.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Scheduled upgrade policy.</p>
|
||
<p>If set to <a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.Info.upgrade_version</span></code> attribute will be reset to
|
||
None.
|
||
If None, the value is unchanged.</p>
|
||
</p></li>
|
||
<li><p><strong>upgrade_version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Target hardware version to be used on the next scheduled virtual
|
||
hardware upgrade.</p>
|
||
<p>If specified, this attribute must represent a newer virtual
|
||
hardware version than the current virtual hardware version reported
|
||
in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.Info.version</span></code>.
|
||
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpdateSpec.upgrade_policy</span></code> is set to
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><code class="xref py py-attr docutils literal notranslate"><span class="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>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy">
|
||
<em class="property">class </em><code class="sig-name descname">UpgradePolicy</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code> class defines the valid virtual hardware
|
||
upgrade policies for a virtual machine.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpgradePolicy</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN">
|
||
<code class="sig-name descname">AFTER_CLEAN_SHUTDOWN</code><em class="property"> = UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')</em><a class="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
|
||
shutdown of the guest operating system.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS">
|
||
<code class="sig-name descname">ALWAYS</code><em class="property"> = UpgradePolicy(string='ALWAYS')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER">
|
||
<code class="sig-name descname">NEVER</code><em class="property"> = UpgradePolicy(string='NEVER')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus">
|
||
<em class="property">class </em><code class="sig-name descname">UpgradeStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus</span></code> class defines the valid virtual hardware
|
||
upgrade statuses for a virtual machine.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpgradeStatus</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED">
|
||
<code class="sig-name descname">FAILED</code><em class="property"> = UpgradeStatus(string='FAILED')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.NONE">
|
||
<code class="sig-name descname">NONE</code><em class="property"> = UpgradeStatus(string='NONE')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.PENDING">
|
||
<code class="sig-name descname">PENDING</code><em class="property"> = UpgradeStatus(string='PENDING')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.SUCCESS">
|
||
<code class="sig-name descname">SUCCESS</code><em class="property"> = UpgradeStatus(string='SUCCESS')</em><a class="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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version">
|
||
<em class="property">class </em><code class="sig-name descname">Version</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.Version</span></code> class defines the valid virtual hardware versions
|
||
for a virtual machine. See <a class="reference external" href="https://kb.vmware.com/s/article/1003746">https://kb.vmware.com/s/article/1003746</a> (Virtual
|
||
machine hardware versions (1003746)).</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_03">
|
||
<code class="sig-name descname">VMX_03</code><em class="property"> = Version(string='VMX_03')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_03" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 3, first supported in ESXi 2.5.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_04">
|
||
<code class="sig-name descname">VMX_04</code><em class="property"> = Version(string='VMX_04')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_04" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 4, first supported in ESXi 3.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_06">
|
||
<code class="sig-name descname">VMX_06</code><em class="property"> = Version(string='VMX_06')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_06" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 6, first supported in WS 6.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_07">
|
||
<code class="sig-name descname">VMX_07</code><em class="property"> = Version(string='VMX_07')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_07" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 7, first supported in ESXi 4.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_08">
|
||
<code class="sig-name descname">VMX_08</code><em class="property"> = Version(string='VMX_08')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_08" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 8, first supported in ESXi 5.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_09">
|
||
<code class="sig-name descname">VMX_09</code><em class="property"> = Version(string='VMX_09')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_09" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 9, first supported in ESXi 5.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_10">
|
||
<code class="sig-name descname">VMX_10</code><em class="property"> = Version(string='VMX_10')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 10, first supported in ESXi 5.5.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_11">
|
||
<code class="sig-name descname">VMX_11</code><em class="property"> = Version(string='VMX_11')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_11" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 11, first supported in ESXi 6.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_12">
|
||
<code class="sig-name descname">VMX_12</code><em class="property"> = Version(string='VMX_12')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_12" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 12, first supported in Workstation 12.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_13">
|
||
<code class="sig-name descname">VMX_13</code><em class="property"> = Version(string='VMX_13')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_13" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 13, first supported in ESXi 6.5.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_14">
|
||
<code class="sig-name descname">VMX_14</code><em class="property"> = Version(string='VMX_14')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_14" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware version 14, first supported in ESXi 6.7. This class attribute was
|
||
added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_15">
|
||
<code class="sig-name descname">VMX_15</code><em class="property"> = Version(string='VMX_15')</em><a class="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
|
||
attribute was added in vSphere API 6.7.2.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Info" title="com.vmware.vcenter.vm_client.Hardware.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Virtual hardware settings of the virtual machine.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec" title="com.vmware.vcenter.vm_client.Hardware.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpdateSpec</span></code></a>) – Specification for updating the virtual hardware settings of the
|
||
virtual machine.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if the virtual machine is already configured for the desired
|
||
hardware version.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the requested virtual hardware version is not newer than the
|
||
current version.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the requested virtual hardware version is not supported by the
|
||
server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is busy performing another operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Hardware.upgrade">
|
||
<code class="sig-name descname">upgrade</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">version=None</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – New virtual machine version.
|
||
If None, defaults to the most recent virtual hardware version
|
||
supported by the server.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the virtual machine is not powered off.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if the virtual machine is already configured for the desired
|
||
hardware version.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">version</span></code> is older than the current virtual hardware version.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">version</span></code> is not supported by the server.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is busy performing another operation.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Identity">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">Identity</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Identity" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Identity.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">bios_uuid=None</em>, <em class="sig-param">instance_uuid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Identity.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">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>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine name. This attribute was added in vSphere API
|
||
6.7.1.</p></li>
|
||
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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
|
||
was added in vSphere API 6.7.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.LibraryItem">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">LibraryItem</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem</span></code> class provides methods to identify virtual machines
|
||
managed by Content Library. This class was added in vSphere API 6.9.1.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo">
|
||
<em class="property">class </em><code class="sig-name descname">CheckOutInfo</code><span class="sig-paren">(</span><em class="sig-param">library_item=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CheckOutInfo</span></code> class contains information about a virtual
|
||
machine checked out of a content library item. This class was added in
|
||
vSphere API 6.9.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item that the virtual machine is checked
|
||
out from. This attribute was added in vSphere API 6.9.1.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.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: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.LibraryItem.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">check_out=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.Info</span></code> class contains information about the library item
|
||
associated with a virtual machine. This class was added in vSphere API
|
||
6.9.1.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>check_out</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo" title="com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CheckOutInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about the checked out virtual machine. This attribute
|
||
was added in vSphere API 6.9.1.
|
||
If None, the virtual machine is not checked out from a library
|
||
item.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.LibraryItem.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the information about the library item associated with the
|
||
virtual machine. This method was added in vSphere API 6.9.1.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.LibraryItem.Info" title="com.vmware.vcenter.vm_client.LibraryItem.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the library item associated with the virtual
|
||
machine.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Power">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">Power</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Power</span></code> class provides methods for managing the power state of a
|
||
virtual machine.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">clean_power_off=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Power.Info</span></code> class contains information about the power state of a
|
||
virtual machine.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.State" title="com.vmware.vcenter.vm_client.Power.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
|
||
<li><p><strong>clean_power_off</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual machine was powered off
|
||
cleanly. This attribute may be used to detect that the virtual
|
||
machine crashed unexpectedly and should be restarted.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF" title="com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Power.State.POWERED_OFF</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.State">
|
||
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Power.State</span></code> class defines the valid power states for a virtual
|
||
machine.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.State.POWERED_OFF">
|
||
<code class="sig-name descname">POWERED_OFF</code><em class="property"> = State(string='POWERED_OFF')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The virtual machine is powered off.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.State.POWERED_ON">
|
||
<code class="sig-name descname">POWERED_ON</code><em class="property"> = State(string='POWERED_ON')</em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_ON" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The virtual machine is powered on.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.State.SUSPENDED">
|
||
<code class="sig-name descname">SUSPENDED</code><em class="property"> = State(string='SUSPENDED')</em><a class="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>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.Info" title="com.vmware.vcenter.vm_client.Power.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Power state information for the specified virtual machine.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the virtual machine’s configuration or execution state cannot be
|
||
accessed.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.reset">
|
||
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.reset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resets a powered-on virtual machine.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the virtual machine is powered off or suspended.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is performing another operation</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.start">
|
||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if the virtual machine is already powered on.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||
if the virtual machine does not support being powered on (e.g.
|
||
marked as a template, serving as a fault-tolerance secondary
|
||
virtual machine).</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if resources cannot be allocated for the virtual machine (e.g.
|
||
physical resource allocation policy cannot be satisfied,
|
||
insufficient licenses are available to run the virtual machine).</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if resources required by the virtual machine are not accessible
|
||
(e.g. virtual machine configuration files or virtual disks are on
|
||
inaccessible storage, no hosts are available to run the virtual
|
||
machine).</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
||
if resources required by the virtual machine are in use (e.g.
|
||
virtual machine configuration files or virtual disks are locked,
|
||
host containing the virtual machine is an HA failover host).</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is performing another operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.stop">
|
||
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if the virtual machine is already powered off.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is performing another operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_client.Power.suspend">
|
||
<code class="sig-name descname">suspend</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.suspend" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Suspends a powered-on virtual machine.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the virtual machine is not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
||
if the virtual machine is already suspended.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the virtual machine is powered off.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||
if the virtual machine is performing another operation.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.vm_template_client">
|
||
<span id="com-vmware-vcenter-vm-template-client-module"></span><h2>com.vmware.vcenter.vm_template_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm_template_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="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>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_template_client.</code><code class="sig-name descname">LibraryItems</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems</span></code> class provides methods to deploy virtual machines from
|
||
library items containing virtual machine templates, as well as methods to
|
||
create library items containing virtual machine templates. The
|
||
<code class="docutils literal notranslate"><span class="pre">LibraryItems</span></code> class also provides an operation to retrieve information
|
||
about the template contained in the library item. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo">
|
||
<em class="property">class </em><code class="sig-name descname">CpuInfo</code><span class="sig-paren">(</span><em class="sig-param">count=None</em>, <em class="sig-param">cores_per_socket=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CpuInfo</span></code> class contains CPU related information about
|
||
the virtual machine template. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of CPU cores per socket. This attribute was added in vSphere
|
||
API 6.8.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CpuUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">num_cpus=None</em>, <em class="sig-param">num_cores_per_socket=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CpuUpdateSpec</span></code> class describes updates to the CPU
|
||
configuration of the deployed virtual machine. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>num_cpus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of virtual processors in the deployed virtual machine. This
|
||
attribute was added in vSphere API 6.8.
|
||
If {\@term.unset}, the deployed virtual machine has the same CPU
|
||
count as the source virtual machine template contained in the
|
||
library item.</p></li>
|
||
<li><p><strong>num_cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of cores among which to distribute CPUs in the deployed
|
||
virtual machine. This attribute was added in vSphere API 6.8.
|
||
If {\@term.unset}, the deployed virtual machine has the same
|
||
number of cores per socket as the source virtual machine template
|
||
contained in the library item.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreatePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec</span></code> class contains information used to
|
||
place a virtual machine template onto resources within the vCenter
|
||
inventory. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the virtual machine template
|
||
should be placed. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
||
When methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
||
If None, the virtual machine template will be placed in the same
|
||
folder as the source virtual machine.</p></li>
|
||
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the virtual machine template should be
|
||
placed. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
||
If None, the system will attempt to choose a suitable resource pool
|
||
for the virtual machine template; if a resource pool cannot be
|
||
chosen, the library item creation operation will fail.</p></li>
|
||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Host onto which the virtual machine template should be placed. If
|
||
<code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code>
|
||
must belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>. If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both
|
||
specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute
|
||
was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
||
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster onto which the virtual machine template should be placed.
|
||
If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
||
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and
|
||
<code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of
|
||
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">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: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
||
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
|
||
that this attribute be None.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">source_vm=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">library=None</em>, <em class="sig-param">vm_home_storage=None</em>, <em class="sig-param">disk_storage=None</em>, <em class="sig-param">disk_storage_overrides=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code> class defines the information required to
|
||
create a library item containing a virtual machine template. This class was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source_vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the library item. This attribute was added in
|
||
vSphere API 6.8.
|
||
If None, the newly created library item has the same description as
|
||
the source virtual machine.</p></li>
|
||
<li><p><strong>library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.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: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
||
<li><p><strong>vm_home_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage location for the virtual machine template’s configuration
|
||
and log files. This attribute was added in vSphere API 6.8.
|
||
If None, the virtual machine template’s configuration and log files
|
||
are placed on the default storage backing associated with the
|
||
library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p></li>
|
||
<li><p><strong>disk_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage specification for the virtual machine template’s disks.
|
||
This attribute was added in vSphere API 6.8.
|
||
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
specified, all of the virtual machine template’s disks are created
|
||
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
None, disks with identifiers that are not in
|
||
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are placed in the default storage backing
|
||
associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
|
||
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
|
||
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>disk_storage_overrides</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage specification for individual disks in the virtual machine
|
||
template. This is specified as a mapping between disk identifiers
|
||
in the source virtual machine and their respective storage
|
||
specifications. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||
a value of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
specified, all of the virtual machine template’s disks are created
|
||
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
None, disks with identifiers that are not in
|
||
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are placed in the default storage backing
|
||
associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
|
||
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
|
||
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Information used to place the virtual machine template. This
|
||
attribute was added in vSphere API 6.8.
|
||
This attribute is currently required. In the future, if this
|
||
attribute is None, the system will place the virtual machine
|
||
template on a suitable resource.</p>
|
||
<p>If specified, each attribute will be used for placement. If the
|
||
attributes result in disjoint placement, the operation will fail.
|
||
If the attributes along with the placement values of the source
|
||
virtual machine result in disjoint placement, the operation will
|
||
fail.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpecDiskStorage</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code> class defines the storage
|
||
specification for a virtual machine template’s disks. This class was added
|
||
in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
This attribute is currently required. If None, <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code>
|
||
must be set. The server picks a datastore that is compatible with
|
||
the specified storage policy.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">datastore</span></code> and <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> are specified, and the
|
||
storage policy is incompatible with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the
|
||
disk will be flagged as being out of compliance with the specified
|
||
storage policy.</p>
|
||
</p></li>
|
||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy for a virtual machine template’s disk. This
|
||
attribute was added in vSphere API 6.8.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the virtual machine
|
||
template’s disk is created with the default storage policy
|
||
associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpecDiskStoragePolicy</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy</span></code> class defines the storage
|
||
policy specification for a virtual machine template’s disks. This class was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
|
||
in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>Policy type for a virtual machine template’s disk. This enumeration was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY">
|
||
<code class="sig-name descname">USE_SPECIFIED_POLICY</code><em class="property"> = Type(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use the specified policy. This class attribute was added in vSphere API
|
||
6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpecVmHomeStorage</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage</span></code> class defines the storage
|
||
specification for a virtual machine template’s configuration and log files.
|
||
This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Identifier of the datastore for the virtual machine template’s
|
||
configuration and log files. This attribute was added in vSphere
|
||
API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
This attribute is currently required. If None, <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code>
|
||
must be set. The server picks a datastore that is compatible with
|
||
the specified storage policy.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">datastore</span></code> and <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> are specified, and the
|
||
storage policy is incompatible with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the
|
||
virtual machine template will be flagged as being out of compliance
|
||
with the specified storage policy.</p>
|
||
</p></li>
|
||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy for the virtual machine template’s configuration and
|
||
log files. This attribute was added in vSphere API 6.8.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the virtual machine
|
||
template’s configuration and log files are created with the default
|
||
storage policy associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpecVmHomeStoragePolicy</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy</span></code> class defines the
|
||
storage policy specification for a virtual machine template’s configuration
|
||
and log files. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the virtual machine template’s
|
||
configuration and log files. This attribute was added in vSphere
|
||
API 6.8.</p></li>
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
|
||
in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>Policy type for the virtual machine template’s configuration and log files.
|
||
This enumeration was added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY">
|
||
<code class="sig-name descname">USE_SPECIFIED_POLICY</code><em class="property"> = Type(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use the specified policy. This class attribute was added in vSphere API
|
||
6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec">
|
||
<em class="property">class </em><code class="sig-name descname">DeployPlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec</span></code> class contains information used to
|
||
place a virtual machine onto resources within the vCenter inventory. This
|
||
class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Virtual machine folder into which the deployed virtual machine
|
||
should be placed. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
||
When methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
||
This attribute is currently required.</p>
|
||
<p>If None, the system will attempt to choose a suitable folder for
|
||
the virtual machine; if a folder cannot be chosen, the virtual
|
||
machine deployment operation will fail.</p>
|
||
</p></li>
|
||
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the deployed virtual machine should be
|
||
placed. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
||
If None, the system will attempt to choose a suitable resource pool
|
||
for the virtual machine; if a resource pool cannot be chosen, the
|
||
virtual machine deployment operation will fail.</p></li>
|
||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Host onto which the virtual machine should be placed. If <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
||
and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must
|
||
belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>. If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified,
|
||
<code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute was added
|
||
in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
||
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster onto which the deployed virtual machine should be placed.
|
||
If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
||
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and
|
||
<code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of
|
||
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">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: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
||
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
|
||
that this attribute be None.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">vm_home_storage=None</em>, <em class="sig-param">disk_storage=None</em>, <em class="sig-param">disk_storage_overrides=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">powered_on=None</em>, <em class="sig-param">guest_customization=None</em>, <em class="sig-param">hardware_customization=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code> class defines the deployment parameters
|
||
that can be specified for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the deployed virtual machine. This attribute was added in
|
||
vSphere API 6.8.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the deployed virtual machine. This attribute was
|
||
added in vSphere API 6.8.
|
||
If None, the deployed virtual machine has the same description as
|
||
the source library item.</p></li>
|
||
<li><p><strong>vm_home_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage location for the deployed virtual machine’s configuration
|
||
and log files. This attribute was added in vSphere API 6.8.
|
||
If None, the deployed virtual machine’s configuration and log files
|
||
are created with the same storage spec as the source virtual
|
||
machine template’s configuration and log files.</p></li>
|
||
<li><p><strong>disk_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage specification for the deployed virtual machine’s disks.
|
||
This attribute was added in vSphere API 6.8.
|
||
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
specified, all of the deployed virtual machine’s disks are created
|
||
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
None, disks with identifiers that are not in
|
||
<code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
|
||
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
|
||
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>disk_storage_overrides</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage specification for individual disks in the deployed virtual
|
||
machine. This is specified as a mapping between disk identifiers in
|
||
the source virtual machine template contained in the library item
|
||
and their storage specifications. This attribute was added in
|
||
vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||
a value of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
specified, all of the deployed virtual machine’s disks are created
|
||
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
|
||
None, disks with identifiers that are not in
|
||
<code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
|
||
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
|
||
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Information used to place the deployed virtual machine. This
|
||
attribute was added in vSphere API 6.8.
|
||
This attribute is currently required. In the future, if this
|
||
attribute is None, the system will use the values from the source
|
||
virtual machine template contained in the library item.</p>
|
||
<p>If specified, each attribute will be used for placement. If the
|
||
attributes result in disjoint placement, the operation will fail.
|
||
If the attributes along with the placement values of the source
|
||
virtual machine template result in disjoint placement, the
|
||
operation will fail.</p>
|
||
</p></li>
|
||
<li><p><strong>powered_on</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies whether the deployed virtual machine should be powered on
|
||
after deployment. This attribute was added in vSphere API 6.8.
|
||
If None, the virtual machine will not be powered on after
|
||
deployment.</p></li>
|
||
<li><p><strong>guest_customization</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.GuestCustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Guest customization spec to apply to the deployed virtual machine.
|
||
This attribute was added in vSphere API 6.8.
|
||
If None, the guest operating system is not customized after
|
||
deployment.</p></li>
|
||
<li><p><strong>hardware_customization</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Hardware customization spec which specifies updates to the deployed
|
||
virtual machine. This attribute was added in vSphere API 6.8.
|
||
If None, the deployed virtual machine has the same hardware
|
||
configuration as the source virtual machine template contained in
|
||
the library item.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpecDiskStorage</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code> class contains the storage
|
||
specification for disks in the virtual machine. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
This attribute is currently required. If None, <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code>
|
||
must be set. The server picks a datastore that is compatible with
|
||
the specified storage policy.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">datastore</span></code> and <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> are specified, and the
|
||
storage policy is incompatible with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the
|
||
disk will be flagged as being out of compliance with the specified
|
||
storage policy.</p>
|
||
</p></li>
|
||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy for the deployed virtual machine’s disk. This
|
||
attribute was added in vSphere API 6.8.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the deployed virtual
|
||
machine’s disk is created with the default storage policy
|
||
associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpecDiskStoragePolicy</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy</span></code> class describes the
|
||
storage policy specification for the deployed virtual machine’s disks. This
|
||
class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy to use. This attribute was added
|
||
in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>Policy type for the deployed virtual machine’s disk. This enumeration was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SOURCE_POLICY">
|
||
<code class="sig-name descname">USE_SOURCE_POLICY</code><em class="property"> = Type(string='USE_SOURCE_POLICY')</em><a class="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
|
||
vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY">
|
||
<code class="sig-name descname">USE_SPECIFIED_POLICY</code><em class="property"> = Type(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use the specified policy. This class attribute was added in vSphere API
|
||
6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpecVmHomeStorage</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage</span></code> class defines the storage
|
||
specification for a deployed virtual machine’s configuration and log files.
|
||
This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Identifier of the datastore for the deployed virtual machine’s
|
||
configuration and log files. This attribute was added in vSphere
|
||
API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
||
This attribute is currently required. If None, <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code>
|
||
must be set. The server picks a datastore that is compatible with
|
||
the specified storage policy.</p>
|
||
<p>If both <code class="docutils literal notranslate"><span class="pre">datastore</span></code> and <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> are specified, and the
|
||
storage policy is incompatible with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the
|
||
deployed virtual machine will be flagged as being out of compliance
|
||
with the specified storage policy.</p>
|
||
</p></li>
|
||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy for the deployed virtual machine’s configuration and
|
||
log files. This attribute was added in vSphere API 6.8.
|
||
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the deployed virtual
|
||
machine’s configuration and log files are created with the default
|
||
storage policy associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy">
|
||
<em class="property">class </em><code class="sig-name descname">DeploySpecVmHomeStoragePolicy</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy</span></code> class defines the
|
||
storage policy specification for the deployed virtual machine’s
|
||
configuration and log files. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the deployed virtual machine’s
|
||
configuration and log files. This attribute was added in vSphere
|
||
API 6.8.</p></li>
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
|
||
in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type">
|
||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>Policy type for the deployed virtual machine’s configuration and log files.
|
||
This enumeration was added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SOURCE_POLICY">
|
||
<code class="sig-name descname">USE_SOURCE_POLICY</code><em class="property"> = Type(string='USE_SOURCE_POLICY')</em><a class="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
|
||
vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY">
|
||
<code class="sig-name descname">USE_SPECIFIED_POLICY</code><em class="property"> = Type(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use the specified policy. This class attribute was added in vSphere API
|
||
6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo">
|
||
<em class="property">class </em><code class="sig-name descname">DiskInfo</code><span class="sig-paren">(</span><em class="sig-param">capacity=None</em>, <em class="sig-param">disk_storage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskInfo</span></code> class contains information about the virtual
|
||
machine template’s virtual disk. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskStorageInfo</span></code></a>) – Disk storage related information. This attribute was added in
|
||
vSphere API 6.8.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo">
|
||
<em class="property">class </em><code class="sig-name descname">DiskStorageInfo</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskStorageInfo</span></code> class contains storage related
|
||
information about a virtual machine template’s virtual disk. This class was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datastore where the disk is stored. This
|
||
attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
|
||
<li><p><strong>storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the storage policy associated with the virtual disk.
|
||
This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
If None, the virtual disk does not have a storage policy associated
|
||
with it.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">DiskUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">capacity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskUpdateSpec</span></code> class describes updates to the
|
||
configuration of a virtual disk in the deployed virtual machine. This class
|
||
was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Updated capacity of the virtual disk backing in bytes. This value
|
||
has to be larger than the original capacity of the disk. This
|
||
attribute was added in vSphere API 6.8.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo">
|
||
<em class="property">class </em><code class="sig-name descname">EthernetInfo</code><span class="sig-paren">(</span><em class="sig-param">backing_type=None</em>, <em class="sig-param">mac_type=None</em>, <em class="sig-param">network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo</span></code> class contains information about a
|
||
virtual machine template’s virtual Ethernet adapter. This class was added
|
||
in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>backing_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the network backing the virtual Ethernet adapter.
|
||
This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
||
When methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
||
This attribute will be None if the identifier of the network
|
||
backing could not be determined.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType">
|
||
<em class="property">class </em><code class="sig-name descname">MacAddressType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.MacAddressType</span></code> class defines the valid
|
||
MAC address origins for a virtual Ethernet adapter. This enumeration was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MacAddressType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.ASSIGNED">
|
||
<code class="sig-name descname">ASSIGNED</code><em class="property"> = MacAddressType(string='ASSIGNED')</em><a class="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
|
||
in vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.GENERATED">
|
||
<code class="sig-name descname">GENERATED</code><em class="property"> = MacAddressType(string='GENERATED')</em><a class="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
|
||
vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.MANUAL">
|
||
<code class="sig-name descname">MANUAL</code><em class="property"> = MacAddressType(string='MANUAL')</em><a class="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
|
||
vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType">
|
||
<em class="property">class </em><code class="sig-name descname">NetworkBackingType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code> class defines valid
|
||
network backing types for a virtual Ethernet adapter. This enumeration was
|
||
added in vSphere API 6.8.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkBackingType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.DISTRIBUTED_PORTGROUP">
|
||
<code class="sig-name descname">DISTRIBUTED_PORTGROUP</code><em class="property"> = NetworkBackingType(string='DISTRIBUTED_PORTGROUP')</em><a class="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
|
||
vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.HOST_DEVICE">
|
||
<code class="sig-name descname">HOST_DEVICE</code><em class="property"> = NetworkBackingType(string='HOST_DEVICE')</em><a class="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
|
||
added in vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK">
|
||
<code class="sig-name descname">OPAQUE_NETWORK</code><em class="property"> = NetworkBackingType(string='OPAQUE_NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Opaque network backing. This class attribute was added in vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.STANDARD_PORTGROUP">
|
||
<code class="sig-name descname">STANDARD_PORTGROUP</code><em class="property"> = NetworkBackingType(string='STANDARD_PORTGROUP')</em><a class="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
|
||
in vSphere API 6.8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">EthernetUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec</span></code> class describes the network that
|
||
the ethernet adapter of the deployed virtual machine should be connected
|
||
to. This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Identifier of the network backing the virtual Ethernet adapter.
|
||
This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
||
When methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
||
This attribute is currently required.</p>
|
||
<p>If None, the virtual Ethernet adapter will be connected to same
|
||
network as it was in the source virtual machine template.</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec">
|
||
<em class="property">class </em><code class="sig-name descname">GuestCustomizationSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.GuestCustomizationSpec</span></code> class contains information
|
||
required to customize the deployed virtual machine. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the customization specification. This attribute was added
|
||
in vSphere API 6.8.
|
||
If None, no guest customization is performed.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec">
|
||
<em class="property">class </em><code class="sig-name descname">HardwareCustomizationSpec</code><span class="sig-paren">(</span><em class="sig-param">nics=None</em>, <em class="sig-param">disks_to_remove=None</em>, <em class="sig-param">disks_to_update=None</em>, <em class="sig-param">cpu_update=None</em>, <em class="sig-param">memory_update=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec</span></code> class defines the hardware
|
||
customization options that are applied to the deployed virtual machine.
|
||
This class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>nics</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Map of Ethernet network adapters to update. This attribute was
|
||
added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
|
||
return a value of this class as a return value, the key in the
|
||
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.
|
||
If None, all Ethernet adapters will remain connected to the same
|
||
network as they were in the source virtual machine template. An
|
||
Ethernet adapter with a MacAddressType of MANUAL will not change.
|
||
An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED
|
||
will receive a new address.</p></li>
|
||
<li><p><strong>disks_to_remove</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Idenfiers of disks to remove from the deployed virtual machine.
|
||
This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
|
||
value of this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||
If None, all disks will be copied.</p></li>
|
||
<li><p><strong>disks_to_update</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskUpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disk update specification for individual disks in the deployed
|
||
virtual machine. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||
a value of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||
If None, disks in the deployed virtual machine will have the same
|
||
settings as the corresponding disks in the source virtual machine
|
||
template contained in the library item.</p></li>
|
||
<li><p><strong>cpu_update</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CpuUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU update specification for the deployed virtual machine. This
|
||
attribute was added in vSphere API 6.8.
|
||
If {\@term.unset}, the deployed virtual machine has the same CPU
|
||
settings as the source virtual machine template contained in the
|
||
library item.</p></li>
|
||
<li><p><strong>memory_update</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.MemoryUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Memory update specification for the deployed virtual machine. This
|
||
attribute was added in vSphere API 6.8.
|
||
If {\@term.unset}, the deployed virtual machine has the same
|
||
memory settings as the source virtual machine template contained in
|
||
the library item.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">guest_os=None</em>, <em class="sig-param">cpu=None</em>, <em class="sig-param">memory=None</em>, <em class="sig-param">vm_home_storage=None</em>, <em class="sig-param">disks=None</em>, <em class="sig-param">nics=None</em>, <em class="sig-param">vm_template=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.Info</span></code> class contains information about a virtual
|
||
machine template item in content library. This class was added in vSphere
|
||
API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>guest_os</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.VmHomeStorageInfo</span></code></a>) – Storage information about the virtual machine template’s
|
||
configuration and log files. This attribute was added in vSphere
|
||
API 6.8.</p></li>
|
||
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskInfo</span></code></a>) – Storage information about the virtual machine template’s virtual
|
||
disks. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||
a value of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
|
||
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo</span></code></a>) – Information about the virtual machine template’s virtual ethernet
|
||
adapters. This attribute was added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
|
||
return a value of this class as a return value, the key in the
|
||
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</p></li>
|
||
<li><p><strong>vm_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo">
|
||
<em class="property">class </em><code class="sig-name descname">MemoryInfo</code><span class="sig-paren">(</span><em class="sig-param">size_mib=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.MemoryInfo</span></code> class contains memory related information
|
||
about the virtual machine template. This class was added in vSphere API
|
||
6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Memory size in mebibytes. This attribute was added in vSphere API
|
||
6.8.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">MemoryUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">memory=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.MemoryUpdateSpec</span></code> class describes updates to the memory
|
||
configuration of the deployed virtual machine. This class was added in
|
||
vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Size of a virtual machine’s memory in MB. This attribute was added
|
||
in vSphere API 6.8.
|
||
If {\@term.unset}, the deployed virtual machine has the same
|
||
memory size as the source virtual machine template.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo">
|
||
<em class="property">class </em><code class="sig-name descname">VmHomeStorageInfo</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.VmHomeStorageInfo</span></code> class contains storage information
|
||
about the virtual machine template’s configuration and log files. This
|
||
class was added in vSphere API 6.8.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datastore where the virtual machine template’s
|
||
configuration and log files are stored. This attribute was added in
|
||
vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
|
||
<li><p><strong>storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the storage policy associated with the virtual
|
||
machine template’s configuration and log files. This attribute was
|
||
added in vSphere API 6.8.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
|
||
If None, the virtual machine template’s configuration and log files
|
||
do not have a storage policy associated with them.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
vSphere API 6.8.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code></a>) – information used to create the library item from the source virtual
|
||
machine.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Identifier of the newly created library item.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if an entity with the name specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.name</span></code> already exists in the folder
|
||
specified by <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.folder</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code></a> contains invalid arguments.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if the operation cannot be performed because of the source virtual
|
||
machine’s current state.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the source virtual machine specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.source_vm</span></code> does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library specified by <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.library</span></code>
|
||
does not exist.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there was an error accessing a file from the source virtual
|
||
machine.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
||
if the source virtual machine is busy.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if any of the services involved in the method are unavailable.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if any of the resources needed to create the virtual machine
|
||
template could not be allocated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.library</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.AddLibraryItem</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.source_vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage.datastore</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.policy</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage.datastore</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy.policy</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
|
||
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.disk_storage_overrides</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.folder</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.resource_pool</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.host</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.deploy">
|
||
<code class="sig-name descname">deploy</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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
|
||
<code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>. It uses the deployment specification in
|
||
<code class="docutils literal notranslate"><span class="pre">spec</span></code>. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.powered_on</span></code> and/or
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="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
|
||
6.8.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the content library item containing the source
|
||
virtual machine template to be deployed.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code></a>) – specification of how the virtual machine should be deployed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Identifier of the deployed virtual machine.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if a virtual machine with the name specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.name</span></code> already exists.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains invalid arguments.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if either a specified host or a specified datastore is in an
|
||
invalid state for the deployment, such as maintenance mode.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> cannot
|
||
be found.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if any resource specified by a attribute of the
|
||
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code></a> class, specified by <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
||
cannot be found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there was an error accessing the source virtual machine template
|
||
contained in the library item specified by
|
||
<code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if there an error accessing any of the resources specified in the
|
||
<code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if any of the services involved in the method are unavailable.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if there was an error in allocating any of the resources required
|
||
by the method.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.DeployTemplate</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage.datastore</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.policy</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage.datastore</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy.policy</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
|
||
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.disk_storage_overrides</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.folder</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.resource_pool</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.host</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>
|
||
referenced by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.nics</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec.network</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
|
||
by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.disks_to_remove</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
|
||
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.disks_to_update</span></code>
|
||
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em><span class="sig-paren">)</span><a class="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 <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>. This method was
|
||
added in vSphere API 6.8.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the library item containing the virtual machine
|
||
template.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.Info" title="com.vmware.vcenter.vm_template_client.LibraryItems.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the virtual machine template item contained in
|
||
the library item.
|
||
If None, the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>
|
||
does not contain a virtual machine template.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the library item could not be found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the virtual machine template’s configuration state cannot be
|
||
accessed.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if any of the services involved in the method are unavailable.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_template_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vcenter.certificate_management.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.certificate_management package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.vapi.std.html" class="btn btn-neutral float-left" title="com.vmware.vapi.std package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |