1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 20:09:58 -05:00
vsphere-automation-sdk-python/vsphere/7.0.1.0/com.vmware.esx.settings.depot_content.html

850 lines
63 KiB
HTML
Raw Normal View History

2020-10-12 01:13:57 -04:00
<!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.depot_content package &mdash; 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.hardware_support package" href="com.vmware.esx.settings.hardware_support.html" />
<link rel="prev" title="com.vmware.esx.settings.defaults.clusters.policies package" href="com.vmware.esx.settings.defaults.clusters.policies.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> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> &raquo;</li>
<li>com.vmware.esx.settings.depot_content package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.esx.settings.depot_content.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.depot_content">
<span id="com-vmware-esx-settings-depot-content-package"></span><h1>com.vmware.esx.settings.depot_content package<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content" title="Permalink to this headline"></a></h1>
<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.depot_content.add_ons_client">
<span id="com-vmware-esx-settings-depot-content-add-ons-client-module"></span><h2>com.vmware.esx.settings.depot_content.add_ons_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.add_ons_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.add_ons_client</span></code> module provides
classes to retrieve OEM specific add-on versions from the depot.</p>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.add_ons_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.add_ons_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.depot_content.add_ons_client.Versions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.add_ons_client.</code><code class="sig-name descname">Versions</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.add_ons_client.Versions" title="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">Versions</span></code> class provides methods to get OEM add-on versions from the
synced 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.add_ons_client.Versions.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.add_ons_client.Versions.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">Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.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.add_ons_client.Versions.ComponentInfo">
<em class="property">class </em><code class="sig-name descname">ComponentInfo</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">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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo" title="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">Versions.ComponentInfo</span></code> class defines the information regarding a
component present in 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>) Identifier 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>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 OEM add-on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.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">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">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">description</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>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">removed_components</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.add_ons_client.Versions.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">Versions.Info</span></code> class defines the information regarding a OEM add-on
version.</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 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>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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Discription of the OEM add-on.</p></li>
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CategoryType</span></code></a>) Category of the OEM add-on.</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.</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.</p></li>
<li><p><strong>components</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.add_ons_client.Versions.ComponentInfo" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ComponentInfo</span></code></a>) List of components in this OEM add-on.</p></li>
<li><p><strong>removed_components</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.add_ons_client.Versions.RemovedComponentInfo" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.RemovedComponentInfo</span></code></a>) List of components removed by this OEM add-on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo">
<em class="property">class </em><code class="sig-name descname">RemovedComponentInfo</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.RemovedComponentInfo" title="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">Versions.RemovedComponentInfo</span></code> class defines the information
regarding a component removed by the 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>) Identifier 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>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.depot_content.add_ons_client.Versions.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">version</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a given OEM add-on version in the depot.</p>
<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
The parameter must 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>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>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info" title="com.vmware.esx.settings.depot_content.add_ons_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the given OEM add-on</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 OEM add-on with given version 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.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.esx.settings.depot_content.base_images_client">
<span id="com-vmware-esx-settings-depot-content-base-images-client-module"></span><h2>com.vmware.esx.settings.depot_content.base_images_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.base_images_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.base_images_client</span></code> module
provides classes to retrieve base_images from the depot.</p>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.base_images_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.base_images_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.base_images_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.depot_content.base_images_client.Versions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.base_images_client.</code><code class="sig-name descname">Versions</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.base_images_client.Versions" title="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">Versions</span></code> class provides methods to get versions of base-images from
the synced 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.base_images_client.Versions.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.base_images_client.Versions.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">Versions.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.base_images_client.Versions.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.base_images_client.Versions.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.base_images_client.Versions.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.base_images_client.Versions.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.base_images_client.Versions.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.base_images_client.Versions.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.base_images_client.Versions.ComponentVersionInfo">
<em class="property">class </em><code class="sig-name descname">ComponentVersionInfo</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">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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo" title="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">Versions.ComponentVersionInfo</span></code> class defines the information
regarding a component present inbase-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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier 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>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 base-image.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.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">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">description</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>, <em class="sig-param"><span class="n">components</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.base_images_client.Versions.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">Versions.Info</span></code> class defines the 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>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Discription of the base-image.</p></li>
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.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>
<li><p><strong>components</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.base_images_client.Versions.ComponentVersionInfo" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.ComponentVersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ComponentVersionInfo</span></code></a>) List of components in this base-image.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.depot_content.base_images_client.Versions.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.base_images_client.Versions.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a given base-image version in the depot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the base-image</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.base_images_client.Versions.Info" title="com.vmware.esx.settings.depot_content.base_images_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the given 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.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 base-image with given version 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.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.esx.settings.depot_content.components_client">
<span id="com-vmware-esx-settings-depot-content-components-client-module"></span><h2>com.vmware.esx.settings.depot_content.components_client module<a class="headerlink" href="#module-com.vmware.esx.settings.depot_content.components_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.depot_content.components_client</span></code> module provides
classes to retrieve component versions from the depot.</p>
<dl class="py class">
<dt id="com.vmware.esx.settings.depot_content.components_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.components_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.components_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.depot_content.components_client.Versions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.depot_content.components_client.</code><code class="sig-name descname">Versions</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.components_client.Versions" title="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">Versions</span></code> class provides methods to get component versions from the
synced 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.components_client.Versions.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.components_client.Versions.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">Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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">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">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">description</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">contact</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.components_client.Versions.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">Versions.Info</span></code> class defines the information regarding a component
version.</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 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>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>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Discription of the component version.</p></li>
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType" title="com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.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.components_client.Versions.UrgencyType" title="com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.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>contact</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Contact email for 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.components_client.Versions.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.components_client.Versions.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">Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.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.components_client.Versions.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">version</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.depot_content.components_client.Versions.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a given component version in the depot.</p>
<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
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the component</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.depot_content.components_client.Versions.Info" title="com.vmware.esx.settings.depot_content.components_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the given component</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 component with given version 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.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.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>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.esx.settings.hardware_support.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.hardware_support package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.esx.settings.defaults.clusters.policies.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.defaults.clusters.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>