mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
3415 lines
294 KiB
HTML
3415 lines
294 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.esx.settings package — vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.esx.settings.clusters package" href="com.vmware.esx.settings.clusters.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.esx.hosts.health package" href="com.vmware.esx.hosts.health.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" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.esx.settings package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.esx.settings.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings">
|
|||
|
|
<span id="com-vmware-esx-settings-package"></span><h1>com.vmware.esx.settings package<a class="headerlink" href="#module-com.vmware.esx.settings" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html">com.vmware.esx.settings.clusters.policies package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#module-com.vmware.esx.settings.clusters.policies.apply_client">com.vmware.esx.settings.clusters.policies.apply_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html">com.vmware.esx.settings.clusters.software.drafts package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#module-com.vmware.esx.settings.clusters.software.drafts.software_client">com.vmware.esx.settings.clusters.software.drafts.software_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html">com.vmware.esx.settings.clusters.software.reports package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.drafts_client">com.vmware.esx.settings.clusters.software.drafts_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.reports_client">com.vmware.esx.settings.clusters.software.reports_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.enablement_client">com.vmware.esx.settings.clusters.enablement_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.policies_client">com.vmware.esx.settings.clusters.policies_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.software_client">com.vmware.esx.settings.clusters.software_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.defaults.html">com.vmware.esx.settings.defaults package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html">com.vmware.esx.settings.defaults.clusters package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html">com.vmware.esx.settings.defaults.clusters.policies package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#module-com.vmware.esx.settings.defaults.clusters.policies_client">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#module-com.vmware.esx.settings.defaults.clusters_client">com.vmware.esx.settings.defaults.clusters_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html">com.vmware.esx.settings.depot_content package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.add_ons_client">com.vmware.esx.settings.depot_content.add_ons_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.base_images_client">com.vmware.esx.settings.depot_content.base_images_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.components_client">com.vmware.esx.settings.depot_content.components_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html">com.vmware.esx.settings.hardware_support package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#module-com.vmware.esx.settings.hardware_support.managers_client">com.vmware.esx.settings.hardware_support.managers_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.clusters_client">
|
|||
|
|
<span id="com-vmware-esx-settings-clusters-client-module"></span><h2>com.vmware.esx.settings.clusters_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client</span></code> module provides classes to
|
|||
|
|
manage desired state configuration and software for a cluster of ESX hosts.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.clusters_client.</code><code class="sig-name descname">DepotOverrides</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">DepotOverrides</span></code> class provides methods to manage software depots
|
|||
|
|
overriden for a given cluster. In general ESX servers reach out to vCenter
|
|||
|
|
(VUM) to fetch the metadata and payloads required for lifecycle operations.
|
|||
|
|
But in ROBO environments ESX clusters can’t (or because of bandwidth
|
|||
|
|
requirements shouldn’t) reach out to vCenter to fetch payloads and
|
|||
|
|
metadata. This class allows setting cluster level overrides for depots. If
|
|||
|
|
any depots are provided for a cluster, then vCenter level depots are not
|
|||
|
|
used for that cluster’s remediation. These are not synced periodically at
|
|||
|
|
vCenter and are only used by ESXs for lifecycle operations.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Depot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">DepotOverrides.Depot</span></code> class defines the information regarding a
|
|||
|
|
particular depot override for a given cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the depot override. This could be a location of zip
|
|||
|
|
file or location to an index.xml file.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depots</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">DepotOverrides.Info</span></code> class defines the information regarding depot
|
|||
|
|
overrides for a given cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot" title="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"><code class="xref py py-class docutils literal notranslate"><span class="pre">DepotOverrides.Depot</span></code></a>) – List of the depot overrides.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides.add">
|
|||
|
|
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.add" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Adds a new depot override to the list of currently configured depot
|
|||
|
|
overrides for a given cluster.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</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>depot</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot" title="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"><code class="xref py py-class docutils literal notranslate"><span class="pre">DepotOverrides.Depot</span></code></a>) – Information of a depot override.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If an invalid location is provided.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if depot override with given information already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.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.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the information about currently configured depot overrides for
|
|||
|
|
a given cluster.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Info" title="com.vmware.esx.settings.clusters_client.DepotOverrides.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">DepotOverrides.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about currently configured depot overrides for a given
|
|||
|
|
cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.DepotOverrides.remove">
|
|||
|
|
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.remove" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Removes a depot override from the list of currently configured depot
|
|||
|
|
overrides for a given cluster.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</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>depot</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot" title="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"><code class="xref py py-class docutils literal notranslate"><span class="pre">DepotOverrides.Depot</span></code></a>) – Information of the depot override to be removed.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 depot override with given information or no cluster
|
|||
|
|
associated with identifier {param.name cluster} in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.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.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.clusters_client.</code><code class="sig-name descname">Software</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software</span></code> class provides methods to manage desired software
|
|||
|
|
specification of an ESX cluster.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ApplyResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">successful_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">failed_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">skipped_hosts</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ApplyResult</span></code> class contains attributes that describe the
|
|||
|
|
result of an <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus" title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ApplyStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the aggregated status of the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code>
|
|||
|
|
method.
|
|||
|
|
None if the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method is in progress.</p></li>
|
|||
|
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit used to fetch the desired software
|
|||
|
|
document to be applied to all hosts within the cluster.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of the hosts in this cluster to which the desired
|
|||
|
|
software document specified by the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.commit</span></code> should be applied to.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus" title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ApplyStatus</span></code></a>) – Status of the hosts in this cluster to which the desired software
|
|||
|
|
document specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.commit</span></code> was
|
|||
|
|
applied to. Hosts on which the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method was
|
|||
|
|
successful are specified by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.successful_hosts</span></code>. Hosts on which the
|
|||
|
|
apply method failed are specified by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.failed_hosts</span></code>. Hosts which were skipped
|
|||
|
|
by the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method are specified by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.skipped_hosts</span></code>.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>successful_hosts</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>) – Hosts in this cluster to which the desired software document
|
|||
|
|
specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.commit</span></code> has been
|
|||
|
|
successfully applied to.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>failed_hosts</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>) – Hosts in this cluster to which the desired software document
|
|||
|
|
specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.ApplyResult.commit</span></code> failed to be
|
|||
|
|
applied to.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>skipped_hosts</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>) – Hosts in this cluster that were skipped by the
|
|||
|
|
<code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ApplySpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">accept_eula</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ApplySpec</span></code> class contains attributes that describe the
|
|||
|
|
specification to be used for applying the desired software document to a
|
|||
|
|
cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The minimum commit identifier of the desired software document to
|
|||
|
|
be used during the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.
|
|||
|
|
if None or empty the apply method will use the latest commit to
|
|||
|
|
fetch the desired state document.</p></li>
|
|||
|
|
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specific hosts within the cluster to be considered during the
|
|||
|
|
<code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.
|
|||
|
|
if None or empty the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method will remediate
|
|||
|
|
all hosts within the cluster.</p></li>
|
|||
|
|
<li><p><strong>accept_eula</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Accept the VMware End User License Agreement (EULA) before starting
|
|||
|
|
the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method. The VMware EULA is available for
|
|||
|
|
download at, <a class="reference external" href="https://www.vmware.com/download/eula.html">https://www.vmware.com/download/eula.html</a>
|
|||
|
|
if None the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method could fail due to the
|
|||
|
|
EULA not being accepted.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ApplyStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ApplyStatus</span></code> class contains attributes that describe the
|
|||
|
|
status of an <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status" title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ApplyStatus.Status</span></code></a>) – The status of the method.</p></li>
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Progress of the operation. This attribute was added in vSphere API
|
|||
|
|
7.0.1.0.
|
|||
|
|
None for cluster ApplyStatus</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method started.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method completed.</p></li>
|
|||
|
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications providing additional information about the status of
|
|||
|
|
the method.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ApplyStatus.Status</span></code> class contains the possible different
|
|||
|
|
status codes that can be returned while trying to <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code>
|
|||
|
|
the desired software specification to hosts within the cluster.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.ERROR">
|
|||
|
|
<code class="sig-name descname">ERROR</code><em class="property"> = Status(string='ERROR')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The method encountered an unspecified error.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.OK">
|
|||
|
|
<code class="sig-name descname">OK</code><em class="property"> = Status(string='OK')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.OK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The method completed successfully.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.RUNNING">
|
|||
|
|
<code class="sig-name descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The method is in progress. This class attribute was added in vSphere API
|
|||
|
|
7.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.SKIPPED">
|
|||
|
|
<code class="sig-name descname">SKIPPED</code><em class="property"> = Status(string='SKIPPED')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.SKIPPED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The method was skipped.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.TIMED_OUT">
|
|||
|
|
<code class="sig-name descname">TIMED_OUT</code><em class="property"> = Status(string='TIMED_OUT')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The method timed out.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.CheckInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CheckInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">check</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.CheckInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckInfo</span></code> class contains attributes that describe a
|
|||
|
|
particular check.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The check identifier.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The check name.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Human-readable check description.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.CheckResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CheckResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">entity_results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.CheckResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckResult</span></code> class contains attributes that describe
|
|||
|
|
aggregated status of all checks performed.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.Status" title="com.vmware.esx.settings.clusters_client.Software.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.Status</span></code></a>) – Aggregated status from all checks performed.</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation started.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation completed.</p></li>
|
|||
|
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit on which checks have been run.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information about the hosts in this cluster for which checks have
|
|||
|
|
been requested to be run.
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>entity_results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult" title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.EntityCheckResult</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">Software.EntityCheckResult</span></code> for all entities for which
|
|||
|
|
checks have been run.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.CheckSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CheckSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.CheckSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckSpec</span></code> class contains attributes that describe the
|
|||
|
|
specification to be used for running checks on the cluster before the
|
|||
|
|
<code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The minimum commit identifier of the desired software document to
|
|||
|
|
be used during the check method.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.
|
|||
|
|
if None or empty the check opertion will use the latest commit to
|
|||
|
|
fetch the desired state document.</p></li>
|
|||
|
|
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specific hosts for which checks need to be performed
|
|||
|
|
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">HostSystem</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">HostSystem</span></code>.
|
|||
|
|
if None or empty checks are run for all hosts within the cluster.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.CheckStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CheckStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">check</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">issues</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.CheckStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckStatus</span></code> class contains attributes that describe a
|
|||
|
|
check result.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>check</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.CheckInfo" title="com.vmware.esx.settings.clusters_client.Software.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckInfo</span></code></a>) – Information about this check.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.Status" title="com.vmware.esx.settings.clusters_client.Software.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.Status</span></code></a>) – The status of this check.</p></li>
|
|||
|
|
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The issues encountered while running this check.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">EntityCheckResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">check_statuses</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.EntityCheckResult</span></code> class contains attributes that describe
|
|||
|
|
aggregated status of all checks performed on a specific entity.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType" title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.EntityCheckResult.EntityType</span></code></a>) – The entity type for which these checks are being run.</p></li>
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If the entity type is CLUSTER then the cluster identifier for which
|
|||
|
|
the checks have been run.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.CLUSTER" title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.EntityCheckResult.EntityType.CLUSTER</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If the entity type is HOST then the host identifier for which the
|
|||
|
|
checks have been run.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST" title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.EntityCheckResult.EntityType.HOST</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.Status" title="com.vmware.esx.settings.clusters_client.Software.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.Status</span></code></a>) – Aggregated status from all checks performed on this entity.</p></li>
|
|||
|
|
<li><p><strong>check_statuses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.CheckStatus" title="com.vmware.esx.settings.clusters_client.Software.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckStatus</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">Software.CheckStatus</span></code> for all checks performed.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">EntityType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.EntityCheckResult.EntityType</span></code> class contains the entitites
|
|||
|
|
on which checks can be performed.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">EntityType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.CLUSTER">
|
|||
|
|
<code class="sig-name descname">CLUSTER</code><em class="property"> = EntityType(string='CLUSTER')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.CLUSTER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Entity type Cluster</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST">
|
|||
|
|
<code class="sig-name descname">HOST</code><em class="property"> = EntityType(string='HOST')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Entity type Host</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ExportSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ExportSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">export_software_spec</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">export_iso_image</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">export_offline_bundle</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ExportSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ExportSpec</span></code> class contains information describing how a
|
|||
|
|
software specification or image should be exported.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>export_software_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether to export software specification document.</p></li>
|
|||
|
|
<li><p><strong>export_iso_image</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether to export ISO image.</p></li>
|
|||
|
|
<li><p><strong>export_offline_bundle</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether to export offline bundle.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ExportType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ExportType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ExportType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.ExportType</span></code> class defines the formats in which software
|
|||
|
|
specification document or image can be exported.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ExportType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ExportType.ISO_IMAGE">
|
|||
|
|
<code class="sig-name descname">ISO_IMAGE</code><em class="property"> = ExportType(string='ISO_IMAGE')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ExportType.ISO_IMAGE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Export ISO image.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ExportType.OFFLINE_BUNDLE">
|
|||
|
|
<code class="sig-name descname">OFFLINE_BUNDLE</code><em class="property"> = ExportType(string='OFFLINE_BUNDLE')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ExportType.OFFLINE_BUNDLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Export offline bundle.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.ExportType.SOFTWARE_SPEC">
|
|||
|
|
<code class="sig-name descname">SOFTWARE_SPEC</code><em class="property"> = ExportType(string='SOFTWARE_SPEC')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.ExportType.SOFTWARE_SPEC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Export software specification document.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.Status">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software.Status</span></code> class defines the status result for a particular
|
|||
|
|
check.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.Status.ERROR">
|
|||
|
|
<code class="sig-name descname">ERROR</code><em class="property"> = Status(string='ERROR')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.Status.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The check indicates an error.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.Status.OK">
|
|||
|
|
<code class="sig-name descname">OK</code><em class="property"> = Status(string='OK')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.Status.OK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The check indicates a success.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.Status.TIMEOUT">
|
|||
|
|
<code class="sig-name descname">TIMEOUT</code><em class="property"> = Status(string='TIMEOUT')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.Status.TIMEOUT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The check did not return in a timely manner.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.Status.WARNING">
|
|||
|
|
<code class="sig-name descname">WARNING</code><em class="property"> = Status(string='WARNING')</em><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.Status.WARNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The check indicates a warning.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.apply_task">
|
|||
|
|
<code class="sig-name descname">apply_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.apply_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Applies the desired software document associated with the given cluster
|
|||
|
|
to hosts within the cluster. If <code class="docutils literal notranslate"><span class="pre">commit</span></code> attribute is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>,
|
|||
|
|
it implies the minimum commit that the <code class="xref py py-func docutils literal notranslate"><span class="pre">Software.apply()</span></code> method
|
|||
|
|
should use, however if subsequent commits have been made to the desired
|
|||
|
|
state document the apply method will use the most recent desired state
|
|||
|
|
document. The result of this operation can be queried by calling the
|
|||
|
|
cis/tasks/{task-id} where the task-id is the response of this
|
|||
|
|
operation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</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>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ApplySpec" title="com.vmware.esx.settings.clusters_client.Software.ApplySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ApplySpec</span></code></a>) – Apply specification.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
If the cluster is already at specified commit as described in the
|
|||
|
|
apply specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is an unknown internal error or if the EULA has not been
|
|||
|
|
accepted. The accompanying error message will give more details
|
|||
|
|
about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If the <code class="docutils literal notranslate"><span class="pre">commit</span></code> attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> specifies an invalid
|
|||
|
|
commit, or the <code class="docutils literal notranslate"><span class="pre">hosts</span></code> attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> specifies an invalid
|
|||
|
|
host or a host not part of the cluster, or the <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is not
|
|||
|
|
managed with a single software specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If there is another operation in progress.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
|||
|
|
if desired software document is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
|||
|
|
If the operation times out.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.check_task">
|
|||
|
|
<code class="sig-name descname">check_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.check_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Runs checks on the cluster before applying the desired software
|
|||
|
|
document across all hosts in the cluster. Checks if all hosts in the
|
|||
|
|
cluster are in a good state to be updated with the desired software
|
|||
|
|
document. If <code class="docutils literal notranslate"><span class="pre">commit</span></code> attribute is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> it implies the
|
|||
|
|
minimum commit that the check method should use, however if subsequent
|
|||
|
|
commits have been made to the desired state document the check method
|
|||
|
|
will use the most recent desired state document. The result of this
|
|||
|
|
operation can be queried by calling the cis/tasks/{task-id} where the
|
|||
|
|
task-id is the response of this operation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</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>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.CheckSpec" title="com.vmware.esx.settings.clusters_client.Software.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckSpec</span></code></a>) – Check specification.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If the <code class="docutils literal notranslate"><span class="pre">commit</span></code> attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> specifies an invalid
|
|||
|
|
commit, or the <code class="docutils literal notranslate"><span class="pre">hosts</span></code> attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> specifies an invalid
|
|||
|
|
host or a host not part of the cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If there is another operation in progress or if the <code class="docutils literal notranslate"><span class="pre">commit</span></code>
|
|||
|
|
attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> specifies a commit that has already been
|
|||
|
|
applied.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
|||
|
|
If the operation times out.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.Software.export">
|
|||
|
|
<code class="sig-name descname">export</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.export" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Exports the desired software specification document and/or image. This
|
|||
|
|
API will not export the solution section of the desired software
|
|||
|
|
specification.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</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>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ExportSpec" title="com.vmware.esx.settings.clusters_client.Software.ExportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ExportSpec</span></code></a>) – </p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters_client.Software.ExportType" title="com.vmware.esx.settings.clusters_client.Software.ExportType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.ExportType</span></code></a> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>A map from export type to URL of the exported data for that type.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 am unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
|||
|
|
if desired software document is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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 id="com.vmware.esx.settings.clusters_client.Software.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the complete desired software specification.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo" title="com.vmware.esx.settings_client.SoftwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Cluster software specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is unknown internal error. The accompanying error message
|
|||
|
|
will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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 id="com.vmware.esx.settings.clusters_client.Software.scan_task">
|
|||
|
|
<code class="sig-name descname">scan_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.Software.scan_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Scans all the hosts in the cluster against the cluster’s desired state.
|
|||
|
|
The result of this operation can be queried by calling the
|
|||
|
|
cis/tasks/{task-id} where the task-id is the response of this
|
|||
|
|
operation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
|||
|
|
if desired software document is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.clusters_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.defaults_client">
|
|||
|
|
<span id="com-vmware-esx-settings-defaults-client-module"></span><h2>com.vmware.esx.settings.defaults_client module<a class="headerlink" href="#module-com.vmware.esx.settings.defaults_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.defaults_client</span></code> module provides classes to
|
|||
|
|
manage defaults that affect management of desired state configuration and
|
|||
|
|
software for ESXi clusters and hosts.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.defaults_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.defaults_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.defaults_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.depot_content_client">
|
|||
|
|
<span id="com-vmware-esx-settings-depot-content-client-module"></span><h2>com.vmware.esx.settings.depot_content_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content_client</span></code> module provides classes to
|
|||
|
|
retrieve contents from the depot.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content_client.</code><code class="sig-name descname">AddOns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AddOns</span></code> class provides methods to get OEM add-ons from the sync’ed
|
|||
|
|
and imported depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">AddOnVersionSummary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">summary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">kb</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">release_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AddOns.AddOnVersionSummary</span></code> class defines the summary information
|
|||
|
|
regarding a version of an OEM add-on.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the OEM add-on.</p></li>
|
|||
|
|
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
|
|||
|
|
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the OEM add-on version.</p></li>
|
|||
|
|
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType" title="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOns.CategoryType</span></code></a>) – Category of the OEM add-on version.</p></li>
|
|||
|
|
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the OEM add-on version.</p></li>
|
|||
|
|
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the OEM add-on version.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CategoryType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AddOns.CategoryType</span></code> class defines possible values of categories for
|
|||
|
|
a OEM add-on.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.BUGFIX">
|
|||
|
|
<code class="sig-name descname">BUGFIX</code><em class="property"> = CategoryType(string='BUGFIX')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bugfix</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.ENHANCEMENT">
|
|||
|
|
<code class="sig-name descname">ENHANCEMENT</code><em class="property"> = CategoryType(string='ENHANCEMENT')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enhancement</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.SECURITY">
|
|||
|
|
<code class="sig-name descname">SECURITY</code><em class="property"> = CategoryType(string='SECURITY')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Security</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vendors</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">versions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AddOns.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing OEM add-ons, see <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.list" title="com.vmware.esx.settings.depot_content_client.AddOns.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">AddOns.list()</span></code></a>).</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vendors</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>) – Vendors that an add-on must have to match the filter.
|
|||
|
|
If None or empty, add-ons from any vendor will match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that an add-on must have to match the filter.
|
|||
|
|
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.add_on</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.add_on</span></code>.
|
|||
|
|
If None or empty, add-ons with any name will match the filter.</p></li>
|
|||
|
|
<li><p><strong>versions</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>) – Versions that an add-on must have to match the filter.
|
|||
|
|
If None or empty, add-ons with any version will match the filter.</p></li>
|
|||
|
|
<li><p><strong>min_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>) – Minimum version of an add-on that can match the filter.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, only OEM add-ons with version greater than or
|
|||
|
|
equal to this will be returned.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.esx.settings.add_on'</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for add-on resource</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">versions</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AddOns.Summary</span></code> class defines the summary information regarding a
|
|||
|
|
OEM add-on.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the OEM add-on.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.add_on</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.add_on</span></code>.</p></li>
|
|||
|
|
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the OEM add-on.</p></li>
|
|||
|
|
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
|
|||
|
|
<li><p><strong>versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary" title="com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOns.AddOnVersionSummary</span></code></a>) – Summary information about the versions of this addon. These are
|
|||
|
|
sorted by the version.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.AddOns.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.AddOns.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a list of currently available OEM add-ons in the depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec" title="com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOns.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specification of matching OEM add-ons.
|
|||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec" title="com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOns.FilterSpec</span></code></a>
|
|||
|
|
with all attributes None, which means all OEM add-ons match the
|
|||
|
|
filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.list" title="com.vmware.esx.settings.depot_content_client.AddOns.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.AddOns.Summary" title="com.vmware.esx.settings.depot_content_client.AddOns.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOns.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of OEM add-ons in the depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is unknown internal error. The accompanying error message
|
|||
|
|
will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content_client.</code><code class="sig-name descname">BaseImages</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImages</span></code> class provides methods to get base-images from the
|
|||
|
|
sync’ed and imported depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CategoryType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImages.CategoryType</span></code> class defines possible values of categories
|
|||
|
|
for a base-image.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.BUGFIX">
|
|||
|
|
<code class="sig-name descname">BUGFIX</code><em class="property"> = CategoryType(string='BUGFIX')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bugfix</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.ENHANCEMENT">
|
|||
|
|
<code class="sig-name descname">ENHANCEMENT</code><em class="property"> = CategoryType(string='ENHANCEMENT')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enhancement</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.SECURITY">
|
|||
|
|
<code class="sig-name descname">SECURITY</code><em class="property"> = CategoryType(string='SECURITY')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Security</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImages.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing base-images, see <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.list" title="com.vmware.esx.settings.depot_content_client.BaseImages.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">BaseImages.list()</span></code></a>).</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>min_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>) – Minimum version of a base-image that can match the filter.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, only base-images with version greater than or
|
|||
|
|
equal to this version will be returned.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.esx.settings.base_image'</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for add-on resource</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">summary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">kb</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">release_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImages.Summary</span></code> class defines the summary information regarding
|
|||
|
|
a base-image.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the base-image.</p></li>
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.base_image</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.base_image</span></code>.</p></li>
|
|||
|
|
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the base-image.</p></li>
|
|||
|
|
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the base-image.</p></li>
|
|||
|
|
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType" title="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.CategoryType</span></code></a>) – Category of the base-image.</p></li>
|
|||
|
|
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the base-image.</p></li>
|
|||
|
|
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.BaseImages.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.BaseImages.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a list of currently available base-images in the depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec" title="com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specification of matching base-images.
|
|||
|
|
If None, the behavior is equivalent to a
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec" title="com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.FilterSpec</span></code></a> with all attributes None, which
|
|||
|
|
means all base-images match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.list" title="com.vmware.esx.settings.depot_content_client.BaseImages.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.BaseImages.Summary" title="com.vmware.esx.settings.depot_content_client.BaseImages.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of base-images in the depot. These will be sorted by the
|
|||
|
|
version of the base-image.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is unknown internal error. The accompanying error message
|
|||
|
|
will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content_client.</code><code class="sig-name descname">Components</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components</span></code> class provides methods to get Components from the
|
|||
|
|
sync’ed and imported depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CategoryType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.CategoryType</span></code> class defines possible values of categories
|
|||
|
|
for a component.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.BUGFIX">
|
|||
|
|
<code class="sig-name descname">BUGFIX</code><em class="property"> = CategoryType(string='BUGFIX')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.BUGFIX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bugfix</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.ENHANCEMENT">
|
|||
|
|
<code class="sig-name descname">ENHANCEMENT</code><em class="property"> = CategoryType(string='ENHANCEMENT')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.ENHANCEMENT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enhancement</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.GENERAL">
|
|||
|
|
<code class="sig-name descname">GENERAL</code><em class="property"> = CategoryType(string='GENERAL')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.GENERAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>General</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.INFO">
|
|||
|
|
<code class="sig-name descname">INFO</code><em class="property"> = CategoryType(string='INFO')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.INFO" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Info</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.MISC">
|
|||
|
|
<code class="sig-name descname">MISC</code><em class="property"> = CategoryType(string='MISC')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.MISC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Misc</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL">
|
|||
|
|
<code class="sig-name descname">RECALL</code><em class="property"> = CategoryType(string='RECALL')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Recall</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL_FIX">
|
|||
|
|
<code class="sig-name descname">RECALL_FIX</code><em class="property"> = CategoryType(string='RECALL_FIX')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL_FIX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Recall-fix</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.CategoryType.SECURITY">
|
|||
|
|
<code class="sig-name descname">SECURITY</code><em class="property"> = CategoryType(string='SECURITY')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.SECURITY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Security</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ComponentBundleType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.ComponentBundleType</span></code> class defines possible ways
|
|||
|
|
components are bundled.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentBundleType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.ADD_ON">
|
|||
|
|
<code class="sig-name descname">ADD_ON</code><em class="property"> = ComponentBundleType(string='ADD_ON')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.ADD_ON" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Components bundled in add-ons</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.BASE_IMAGE">
|
|||
|
|
<code class="sig-name descname">BASE_IMAGE</code><em class="property"> = ComponentBundleType(string='BASE_IMAGE')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.BASE_IMAGE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Components bundled in base-images</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.INDEPENDENT">
|
|||
|
|
<code class="sig-name descname">INDEPENDENT</code><em class="property"> = ComponentBundleType(string='INDEPENDENT')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.INDEPENDENT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Components not bundled in base-images or add-ons</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ComponentVersionSummary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">summary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">urgency</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">kb</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">release_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.ComponentVersionSummary</span></code> class defines the summary
|
|||
|
|
information regarding a version of a component.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
|||
|
|
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component.</p></li>
|
|||
|
|
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of the component version.</p></li>
|
|||
|
|
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType" title="com.vmware.esx.settings.depot_content_client.Components.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.CategoryType</span></code></a>) – Category of the component version.</p></li>
|
|||
|
|
<li><p><strong>urgency</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType" title="com.vmware.esx.settings.depot_content_client.Components.UrgencyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.UrgencyType</span></code></a>) – Urgency of the component version.</p></li>
|
|||
|
|
<li><p><strong>kb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Link to kb article related to this the component version.</p></li>
|
|||
|
|
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the component version.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vendors</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">versions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">bundle_types</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing components, see <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.list" title="com.vmware.esx.settings.depot_content_client.Components.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Components.list()</span></code></a>).</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vendors</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>) – Vendors that a component must have to match the filter.
|
|||
|
|
If None or empty, components with any vendor name match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that a component must have to match the filter.
|
|||
|
|
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 or empty, components with any name will match the filter.</p></li>
|
|||
|
|
<li><p><strong>versions</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>) – Versions that a component must have to match the filter.
|
|||
|
|
If None or empty, components with any version will match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>min_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>) – Minimum version of the component that can match the filter.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, only components with version greater than or equal
|
|||
|
|
to the given version match the filter.</p></li>
|
|||
|
|
<li><p><strong>bundle_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType" title="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.ComponentBundleType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component bundle types that a component must have to match the
|
|||
|
|
filter.
|
|||
|
|
If None or empty, all components will match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.esx.settings.component'</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for add-on resource</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">versions</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.Summary</span></code> class defines the summary information regarding
|
|||
|
|
a component.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Component.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
|
|||
|
|
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the component.</p></li>
|
|||
|
|
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
|||
|
|
<li><p><strong>versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary" title="com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.ComponentVersionSummary</span></code></a>) – Summary information about the versions of this component. These are
|
|||
|
|
sorted by the version.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UrgencyType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Components.UrgencyType</span></code> class defines possible values of urgencies
|
|||
|
|
for a component.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UrgencyType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType.CRITICAL">
|
|||
|
|
<code class="sig-name descname">CRITICAL</code><em class="property"> = UrgencyType(string='CRITICAL')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.CRITICAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Critical</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType.GENERAL">
|
|||
|
|
<code class="sig-name descname">GENERAL</code><em class="property"> = UrgencyType(string='GENERAL')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.GENERAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>General</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType.IMPORTANT">
|
|||
|
|
<code class="sig-name descname">IMPORTANT</code><em class="property"> = UrgencyType(string='IMPORTANT')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.IMPORTANT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Important</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType.LOW">
|
|||
|
|
<code class="sig-name descname">LOW</code><em class="property"> = UrgencyType(string='LOW')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.LOW" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Low</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.UrgencyType.MODERATE">
|
|||
|
|
<code class="sig-name descname">MODERATE</code><em class="property"> = UrgencyType(string='MODERATE')</em><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.MODERATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Moderate</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.Components.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.Components.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a list of currently available components in the depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.FilterSpec" title="com.vmware.esx.settings.depot_content_client.Components.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specification of matching components.
|
|||
|
|
If None, the behavior is equivalent to a
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.FilterSpec" title="com.vmware.esx.settings.depot_content_client.Components.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.FilterSpec</span></code></a> with all attributes None, which
|
|||
|
|
means ALL components match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.list" title="com.vmware.esx.settings.depot_content_client.Components.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.depot_content_client.Components.Summary" title="com.vmware.esx.settings.depot_content_client.Components.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Components.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of components in the depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is unknown internal error. The accompanying error message
|
|||
|
|
will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depot_content_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.depots_client">
|
|||
|
|
<span id="com-vmware-esx-settings-depots-client-module"></span><h2>com.vmware.esx.settings.depots_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depots_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots_client</span></code> module provides classes to manage
|
|||
|
|
VUM compatible ESX Depots.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depots_client.</code><code class="sig-name descname">Offline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline</span></code> class provides methods to manage Offline Software Depots
|
|||
|
|
used during ESX lifecycle management.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.CreateResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.CreateResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline.CreateResult</span></code> class defines the result information for a new
|
|||
|
|
Offline Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the Offline Depot.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.offline</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.offline</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline.CreateSpec</span></code> class defines the information used to create a
|
|||
|
|
depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the depot.
|
|||
|
|
If None, the description will be empty.</p></li>
|
|||
|
|
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType" title="com.vmware.esx.settings.depots_client.Offline.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.SourceType</span></code></a>) – Type of the source from which offline bundle is obtained.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the depot from which content should be retrieved.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>file_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
|
|||
|
|
uploaded.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline.Info</span></code> class defines the information regarding an Offline
|
|||
|
|
Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Depot. If not set during import, it will be
|
|||
|
|
empty.</p></li>
|
|||
|
|
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType" title="com.vmware.esx.settings.depots_client.Offline.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.SourceType</span></code></a>) – Type of the source from which Offline Depot is obtained.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the depot from which content is retrieved.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>file_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
|
|||
|
|
uploaded.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>create_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the depot was created.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.esx.settings.depots.offline'</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for depots resource</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.SourceType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.SourceType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline.SourceType</span></code> class defines possible values of sources for the
|
|||
|
|
offline depot.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL">
|
|||
|
|
<code class="sig-name descname">PULL</code><em class="property"> = SourceType(string='PULL')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Content is pulled from the URL location. The URL scheme of the value in
|
|||
|
|
{\@link #pullLocation) can be http, https or file.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH">
|
|||
|
|
<code class="sig-name descname">PUSH</code><em class="property"> = SourceType(string='PUSH')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Content was previously uploaded using the file upload enpoint present on
|
|||
|
|
vCenter appliance. This endpoint is present at
|
|||
|
|
<a class="reference external" href="https://VCENTERFQDN:9087/vum-fileupload">https://VCENTERFQDN:9087/vum-fileupload</a> URL.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Offline.Summary</span></code> class defines the summary information regarding an
|
|||
|
|
Offline Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Depot. If not set during import, it will be
|
|||
|
|
empty.</p></li>
|
|||
|
|
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType" title="com.vmware.esx.settings.depots_client.Offline.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.SourceType</span></code></a>) – Type of the source from which Offline Depot is obtained.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the depot from which content is retrieved.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>file_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
|
|||
|
|
uploaded.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH" title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.create_task">
|
|||
|
|
<code class="sig-name descname">create_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.create_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Imports a new offline software depot. This will also import the
|
|||
|
|
metadata and payloads from this offline depot. The returned task will
|
|||
|
|
fail and no Offline Depot would be created if there are any issues
|
|||
|
|
during import. The result of this operation can be queried by calling
|
|||
|
|
the cis/tasks/{task-id} where the task-id is the response of this
|
|||
|
|
operation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.CreateSpec" title="com.vmware.esx.settings.depots_client.Offline.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.CreateSpec</span></code></a>) – Depot specification to import an offline depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If an invalid pullLocation is provided.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
If the depot content of <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> already exists. The value of
|
|||
|
|
the data attribute of
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
|
|||
|
|
that contains existing depot content id as part of depot attribute
|
|||
|
|
defined in <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.CreateResult" title="com.vmware.esx.settings.depots_client.Offline.CreateResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.CreateResult</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Removes a depot from the list of imported offline software depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the depot to be removed.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.offline</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 depot associated with parameter <code class="docutils literal notranslate"><span class="pre">depot</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the information about an imported offline software depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the depot.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.offline</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.Info" title="com.vmware.esx.settings.depots_client.Offline.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the imported offline software depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 depot with given identifier <code class="docutils literal notranslate"><span class="pre">depot</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Offline.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Offline.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns currently imported offline software depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Offline.Summary" title="com.vmware.esx.settings.depots_client.Offline.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Offline.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Map of currently imported offline software depots 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.depots.offline</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depots_client.</code><code class="sig-name descname">Online</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Online</span></code> class provides methods to manage Online Software Depots used
|
|||
|
|
during ESX lifecycle management.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Online.CreateSpec</span></code> class defines the information used to create a
|
|||
|
|
depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the Depot.
|
|||
|
|
If None, the description will be empty.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the Depot. It should be the location to the index.xml
|
|||
|
|
for that depot.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether this depot is enabled or not. Disabling the
|
|||
|
|
depot doesn’t delete its cached metadata and payloads. It will not
|
|||
|
|
be refreshed next time depots are re-synced.
|
|||
|
|
If None the depot will be enabled.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_defined</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Online.Info</span></code> class defines the information regarding a Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Depot. It will be an empty string if no
|
|||
|
|
description was provided during create.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the Depot.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether this depot is enabled or not.</p></li>
|
|||
|
|
<li><p><strong>system_defined</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate if the depot is system defined. System defined
|
|||
|
|
depot can not be deleted.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.esx.settings.depots.online'</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for depots resource</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_defined</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Online.Summary</span></code> class defines the summary information regarding a
|
|||
|
|
Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Depot. It will be an empty string if no
|
|||
|
|
description was provided during create.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the Depot.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether this depot is enabled or not.</p></li>
|
|||
|
|
<li><p><strong>system_defined</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate if the depot is system defined. System defined
|
|||
|
|
depot can not be deleted.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Online.UpdateSpec</span></code> class defines the information used to update the
|
|||
|
|
depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether this depot is enabled or not. Disabling the
|
|||
|
|
depot doesn’t delete its cached metadata and payloads. It will not
|
|||
|
|
be refreshed next time depots are re-synced.
|
|||
|
|
If None, enabled flag is not updated.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the Depot.
|
|||
|
|
If None, description is not updated.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Adds a new online software depot to the list of currently configured
|
|||
|
|
online software depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Online.CreateSpec" title="com.vmware.esx.settings.depots_client.Online.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Online.CreateSpec</span></code></a>) – Depot information.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Identifier of the currently configured online software depot.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.online</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If an invalid location is provided.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if depot with given location already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</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.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Removes a depot from the list of currently configured online software
|
|||
|
|
depots. It will not remove the downloaded metadata and payloads from
|
|||
|
|
that depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the depot to be removed.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.online</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If given depot is system defined.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no depot associated with <code class="docutils literal notranslate"><span class="pre">depot</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the information about a currently configured online software
|
|||
|
|
depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the depot.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.online</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depots_client.Online.Info" title="com.vmware.esx.settings.depots_client.Online.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Online.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information of the currently configured online software depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 depot with given identifier <code class="docutils literal notranslate"><span class="pre">depot</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a list of currently configured online software depots.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.depots_client.Online.Summary" title="com.vmware.esx.settings.depots_client.Online.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Online.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Map of currently configured online software depots keyed by their
|
|||
|
|
identifiers.
|
|||
|
|
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.depots.online</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Online.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">depot</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Online.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the configuration of a currently configured online software
|
|||
|
|
depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>depot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the depot to be updated.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depots.online</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Online.UpdateSpec" title="com.vmware.esx.settings.depots_client.Online.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Online.UpdateSpec</span></code></a>) – Update specification.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If given depot is system defined.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no depot associated with parameter <code class="docutils literal notranslate"><span class="pre">depot</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depots_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depots_client.</code><code class="sig-name descname">SyncSchedule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SyncSchedule</span></code> class provides methods to manage Schedule of Online
|
|||
|
|
Software Depot sync.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DayOfWeek</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SyncSchedule.DayOfWeek</span></code> class contains the supported days of the
|
|||
|
|
week.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.FRIDAY">
|
|||
|
|
<code class="sig-name descname">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Friday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.MONDAY">
|
|||
|
|
<code class="sig-name descname">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Monday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SATURDAY">
|
|||
|
|
<code class="sig-name descname">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Saturday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SUNDAY">
|
|||
|
|
<code class="sig-name descname">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Sunday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.THURSDAY">
|
|||
|
|
<code class="sig-name descname">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Thursday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.TUESDAY">
|
|||
|
|
<code class="sig-name descname">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Tuesday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.WEDNESDAY">
|
|||
|
|
<code class="sig-name descname">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Wednesday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Recurrence</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence</span></code> class contains the supported values for how
|
|||
|
|
often to sync from online or UMDS depots.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Recurrence</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY">
|
|||
|
|
<code class="sig-name descname">DAILY</code><em class="property"> = Recurrence(string='DAILY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Daily.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY">
|
|||
|
|
<code class="sig-name descname">HOURLY</code><em class="property"> = Recurrence(string='HOURLY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Hourly.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY">
|
|||
|
|
<code class="sig-name descname">MONTHLY_BY_DAY</code><em class="property"> = Recurrence(string='MONTHLY_BY_DAY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Monthly by day.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY">
|
|||
|
|
<code class="sig-name descname">WEEKLY</code><em class="property"> = Recurrence(string='WEEKLY')</em><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Weekly.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Schedule">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Schedule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">skip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">minute</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hour</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">day_of_month</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">day_of_week</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Schedule" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SyncSchedule.Schedule</span></code> class defines a schedule.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence"><code class="xref py py-class docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence</span></code></a>) – Frequency of the schedule.</p></li>
|
|||
|
|
<li><p><strong>skip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This determines the units of <code class="docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence</span></code> to skip
|
|||
|
|
before the scheduled task runs again. For example, value of 1 for
|
|||
|
|
HOURLY type means the scheduled task runs every 2 hours. The value
|
|||
|
|
must be within the range 0 to 998.
|
|||
|
|
If None, no unit is skipped.</p></li>
|
|||
|
|
<li><p><strong>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minute at which schedule should be run. The value must be within
|
|||
|
|
the range 0 to 59.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.HOURLY</span></code></a>,
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.DAILY</span></code></a>,
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.WEEKLY</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.MONTHLY_BY_DAY</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Hour at which schedule should be run. The value must be within the
|
|||
|
|
range 0 to 23.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.DAILY</span></code></a>,
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.WEEKLY</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.MONTHLY_BY_DAY</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>day_of_month</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Day at which schedule should be run. The value must be within the
|
|||
|
|
range 1 to 31. If the value exceeds the total number of days in the
|
|||
|
|
month, the schedule will run on the last day of the month.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.MONTHLY_BY_DAY</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>day_of_week</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek" title="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">SyncSchedule.DayOfWeek</span></code></a>) – Day of the week when schedule should be run
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY" title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Recurrence.WEEKLY</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.Spec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schedule</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">email_addresses</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Spec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SyncSchedule.Spec</span></code> class defines the information regarding the sync
|
|||
|
|
schedule.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether automatic sync is enabled or not</p></li>
|
|||
|
|
<li><p><strong>schedule</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Schedule" title="com.vmware.esx.settings.depots_client.SyncSchedule.Schedule"><code class="xref py py-class docutils literal notranslate"><span class="pre">SyncSchedule.Schedule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The schedule to check for new updates.
|
|||
|
|
If None the schedule must be disabled.</p></li>
|
|||
|
|
<li><p><strong>email_addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email addresses to which the notification will be sent. If empty,
|
|||
|
|
no notification is sent.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the currently configured software depot sync schedule.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Spec" title="com.vmware.esx.settings.depots_client.SyncSchedule.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SyncSchedule.Spec</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Currently configured sync schedule.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown error. The accompanying error message will
|
|||
|
|
give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.SyncSchedule.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.SyncSchedule.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Sets the software depot sync schedule.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.SyncSchedule.Spec" title="com.vmware.esx.settings.depots_client.SyncSchedule.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SyncSchedule.Spec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information of the software depot sync schedule.
|
|||
|
|
If None, it will be reset to the default schedule, which is daily
|
|||
|
|
at a random hour chosen when this API is called.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Spec.schedule</span></code> is unset while
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">SyncSchedule.Spec.enabled</span></code> is set to true or if any of the
|
|||
|
|
values is not within valid range.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown error. The accompanying error message will
|
|||
|
|
give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depots_client.</code><code class="sig-name descname">Umds</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Umds</span></code> class provides methods to manage VMware vSphere Update Manager
|
|||
|
|
Download Service (UMDS) software depots used during ESX lifecycle
|
|||
|
|
management. This is the depot downloaded using UMDS.</p>
|
|||
|
|
<p>If a UMDS depot is specified then online depots are ignored and data is
|
|||
|
|
downloaded only from the UMDS depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Umds.Info</span></code> class defines the information regarding an UMDS Depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Depot. It will be an empty string if no
|
|||
|
|
description was provided during create.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether or not this depot is enabled.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the Depot.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.SetSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">SetSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.SetSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Umds.SetSpec</span></code> class defines the information of an UMDS depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the Depot.
|
|||
|
|
If None, the description will be empty.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether or not this depot should be enabled.
|
|||
|
|
Disabling the depot doesn’t delete its cached metadata and
|
|||
|
|
payloads. It will not be refreshed next time depots are re-synced.
|
|||
|
|
If None the depot will be enabled.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the Depot. It should be the location to the index.xml
|
|||
|
|
for that depot.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Umds.UpdateSpec</span></code> class defines the information used to update the
|
|||
|
|
UMDS depot.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether or not this depot is enabled. Disabling the
|
|||
|
|
depot doesn’t delete its cached metadata and payloads. It will not
|
|||
|
|
be refreshed next time depots are re-synced.
|
|||
|
|
If None, the enabled flag is not updated.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the Depot.
|
|||
|
|
If None, the description is not updated.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Removes the configured UMDS software depot. It will not remove the
|
|||
|
|
downloaded metadata and payloads from that depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 UMDS software depot set.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the information about a currently configured UMDS software depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.settings.depots_client.Umds.Info" title="com.vmware.esx.settings.depots_client.Umds.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Umds.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Information of the currently configured UMDS software depot.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 UMDS software depot set.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Sets or overwrites information about an UMDS software depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Umds.SetSpec" title="com.vmware.esx.settings.depots_client.Umds.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Umds.SetSpec</span></code></a>) – </p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If an invalid location is provided.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.depots_client.Umds.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depots_client.Umds.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the configuration of a currently configured UMDS software
|
|||
|
|
depot.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depots_client.Umds.UpdateSpec" title="com.vmware.esx.settings.depots_client.Umds.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Umds.UpdateSpec</span></code></a>) – Update specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 UMDS depot configured.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.hardware_support_client">
|
|||
|
|
<span id="com-vmware-esx-settings-hardware-support-client-module"></span><h2>com.vmware.esx.settings.hardware_support_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.hardware_support_client.Managers">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hardware_support_client.</code><code class="sig-name descname">Managers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support_client.Managers" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Managers</span></code> class provides methods to list Hardware Support Manager
|
|||
|
|
(HSM) for a given vCenter.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.hardware_support_client.Managers.HardwareSupportManagerInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">HardwareSupportManagerInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">manager</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support_client.Managers.HardwareSupportManagerInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Managers.HardwareSupportManagerInfo</span></code> class contains attributes that
|
|||
|
|
describe a particular 3rd party Hardware Support Manager (HSM)</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>manager</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Hardware Support Manager (HSM) (e.g. “Frobozz Hardware
|
|||
|
|
Support Manager”)
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.manager</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the attribute will
|
|||
|
|
be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.manager</span></code>.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User-intelligible description of the HSM (e.g. “Front end for
|
|||
|
|
Frobozz so-and-so management system”)</p></li>
|
|||
|
|
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – UI label for HSM, derived from HSM extension’s description’s
|
|||
|
|
‘label’ field. (e.g. “Frobozz Free Management System”)</p></li>
|
|||
|
|
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Company providing the Hardware Support Manager (HSM) (e.g. “Frobozz
|
|||
|
|
Magic Software Company”)</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.hardware_support_client.Managers.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support_client.Managers.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the list of registered Hardware Support Managers (HSMs) in the
|
|||
|
|
system.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.settings.hardware_support_client.Managers.list" title="com.vmware.esx.settings.hardware_support_client.Managers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.hardware_support_client.Managers.HardwareSupportManagerInfo" title="com.vmware.esx.settings.hardware_support_client.Managers.HardwareSupportManagerInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Managers.HardwareSupportManagerInfo</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>List of currently registered Hardware Support Manager (HSMs)</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If there is some unknown internal error. The accompanying error
|
|||
|
|
message will give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the service is not available.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if 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.lifecycleSettings.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.hardware_support_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hardware_support_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.esx.settings.hosts_client">
|
|||
|
|
<span id="com-vmware-esx-settings-hosts-client-module"></span><h2>com.vmware.esx.settings.hosts_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hosts_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.hosts_client</span></code> module provides classes to manage
|
|||
|
|
desired state configuration and software for a standalone ESX host.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.hosts_client.Software">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hosts_client.</code><code class="sig-name descname">Software</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts_client.Software" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Software</span></code> class provides methods to manage desired software
|
|||
|
|
specification of a standalone ESX host.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.settings.hosts_client.Software.scan_task">
|
|||
|
|
<code class="sig-name descname">scan_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts_client.Software.scan_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Scans the host against the host’s desired state.. The result of this
|
|||
|
|
operation can be queried by calling the cis/tasks/{task-id} where the
|
|||
|
|
task-id is the response of this operation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system or if
|
|||
|
|
desired software document is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
If the host is not a standlone host, but instead part of a cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.hosts_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hosts_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.esx.settings.clusters.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.esx.hosts.health.html" class="btn btn-neutral float-left" title="com.vmware.esx.hosts.health package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
|||
|
|
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|