mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
44eb68437b
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com> Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
1325 lines
125 KiB
HTML
1325 lines
125 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>com.vmware.esx.settings.clusters.software.drafts package — vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.esx.settings.clusters.software.reports package" href="com.vmware.esx.settings.clusters.software.reports.html" />
|
||
<link rel="prev" title="com.vmware.esx.settings.clusters.software package" href="com.vmware.esx.settings.clusters.software.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
vSphere Automation SDK for Python.
|
||
</a>
|
||
<div class="version">
|
||
8.0.3.0
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.esx.html">com.vmware.esx package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a></li>
|
||
<li class="breadcrumb-item active">com.vmware.esx.settings.clusters.software.drafts package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/com.vmware.esx.settings.clusters.software.drafts.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="module-com.vmware.esx.settings.clusters.software.drafts">
|
||
<span id="com-vmware-esx-settings-clusters-software-drafts-package"></span><h1>com.vmware.esx.settings.clusters.software.drafts package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.drafts" title="Permalink to this heading"></a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||
</section>
|
||
<section id="module-com.vmware.esx.settings.clusters.software.drafts.software_client">
|
||
<span id="com-vmware-esx-settings-clusters-software-drafts-software-client-module"></span><h2>com.vmware.esx.settings.clusters.software.drafts.software_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.drafts.software_client" title="Permalink to this heading"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client</span></code> module
|
||
provides classes to manage draft of the software documents for ESX cluster.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">AddOn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">AddOn</span></code> class provides methods to manage the OEM add-on specification
|
||
in a software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.RESOURCE_TYPE">
|
||
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.add_on'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resource type for add-on resource</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes the desired OEM add-on specification in the software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the OEM add-on specification in a software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.AddOnInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>OEM add-on specification.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system or no add-on specification
|
||
is set.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.set" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Sets a new desired OEM add-on specification in the software draft. It
|
||
will overwrite the existing desired OEM add-on specification if one
|
||
already exists.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.AddOnSpec" title="com.vmware.esx.settings_client.AddOnSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.AddOnSpec</span></code></a>) – AddOn specification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">BaseImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImage</span></code> class provides methods to manage the base-image
|
||
specification in a software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.RESOURCE_TYPE">
|
||
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.base_image'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resource type for base-image resource</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the base-image specification in a software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Base-image specification.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.set" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Sets a new desired base-image specification in the software draft. It
|
||
will overwrite the existing desired base-image specification if one
|
||
already exists.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.BaseImageSpec" title="com.vmware.esx.settings_client.BaseImageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageSpec</span></code></a>) – Base-image specification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">Components</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Components</span></code> class provides methods to manage component specification
|
||
in a software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.RESOURCE_TYPE">
|
||
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.component'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resource type for component resource</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpdateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">components_to_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components_to_delete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code> class contains attributes that are specified
|
||
to update list of components in the draft.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>components_to_set</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>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of components to be updated. If the component already exists
|
||
in the draft, the version is updated, else it is added. If a
|
||
component is provided without version, then its version will be
|
||
chosen based on constraints in the system.
|
||
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.esx.settings.component</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.esx.settings.component</span></code>.
|
||
If None, no components will be added or updated.</p></li>
|
||
<li><p><strong>components_to_delete</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 components to be removed.
|
||
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.esx.settings.component</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.esx.settings.component</span></code>.
|
||
If None, no components will be removed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes the given component from the software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the component version for the given component in the software
|
||
draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about component version.
|
||
If None then version will be chosen based on the constraints in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> or no component associated with
|
||
<code class="docutils literal notranslate"><span class="pre">component</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the components that comprise the software draft.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></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.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Map of component version information keyed by the component
|
||
identifier.
|
||
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.esx.settings.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.set" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Set the component version for a given component in the software draft.
|
||
This will overwrite any existing version for the given component.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component version.
|
||
This attribute is currently required. In the future,if this
|
||
attribute is None then version is chosen based on the constraints
|
||
in the system.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.update">
|
||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.update" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Updates the list of components in a given draft. This allows set and/or
|
||
delete of multiple components in a batch operation.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec" title="com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code></a>) – Update specification containing list of components to add and/or
|
||
delete.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">EffectiveComponents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">EffectiveComponents</span></code> class provides methods to manage effective list
|
||
of components.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the components that comprise the desired software state of the
|
||
cluster.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></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.esx.html#com.vmware.esx.settings_client.EffectiveComponentInfo" title="com.vmware.esx.settings_client.EffectiveComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.EffectiveComponentInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Map of effective components keyed by their identifier.
|
||
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.esx.settings.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list_with_removed_components">
|
||
<span class="sig-name descname"><span class="pre">list_with_removed_components</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list_with_removed_components" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the list of all the effective components. Pass the param
|
||
“with-removed-components” to get even the removed components. This
|
||
method was added in vSphere API 8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></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.esx.html#com.vmware.esx.settings_client.EffectiveComponentInfo" title="com.vmware.esx.settings_client.EffectiveComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.EffectiveComponentInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Map of effective components keyed by their identifier.
|
||
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.esx.settings.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no such cluster <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">HardwareSupport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">HardwareSupport</span></code> class provides methods to manage a cluster’s
|
||
Hardware Support Package (HSP) configuration in working copy documents.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes a given cluster’s working copy document Hardware Support
|
||
Package (HSP) configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||
configured as part of the working copy document.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns a given cluster’s working copy document Hardware Support
|
||
Package (HSP) configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportInfo" title="com.vmware.esx.settings_client.HardwareSupportInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Hardware Support Package (HSP) configured for use</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||
configured as part of the working copy document.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.set" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Replaces a given cluster’s working copy document Hardware Support
|
||
Package (HSP) configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of image working copy document being updated
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportSpec" title="com.vmware.esx.settings_client.HardwareSupportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportSpec</span></code></a>) – new Hardware Support Package (HSP) configuration for the cluster</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code>, no working copy document
|
||
<code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system, or no Hardware Support Package (HSP)
|
||
configured as part of the working copy document.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">RemovedComponents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">RemovedComponents</span></code> class provides methods to manage removal of
|
||
components in a software draft. This class was added in vSphere API
|
||
8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.RESOURCE_TYPE">
|
||
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.component'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resource type for component resource. This class attribute was added in vSphere
|
||
API 8.0.3.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes the given component from the removed components section of the
|
||
software draft. This method was added in vSphere API 8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller does not have the necessary privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if 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">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the component information for the given removed component in
|
||
the software draft. This method was added in vSphere API 8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about component version.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> or no component associated with
|
||
<code class="docutils literal notranslate"><span class="pre">component</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller does not have the necessary privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if 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">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the components that comprise the removed components section of
|
||
the software draft. This method was added in vSphere API 8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></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.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Map of component information keyed by the component identifier.
|
||
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.esx.settings.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller does not have the necessary privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if 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">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.set" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Set the component to be removed in the software draft. This method was
|
||
added in vSphere API 8.0.3.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy document.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
|
||
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
|
||
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller does not have the necessary privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if 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">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts.software_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="com.vmware.esx.settings.clusters.software.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters.software package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="com.vmware.esx.settings.clusters.software.reports.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters.software.reports package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2024, Broadcom, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |