mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
469 lines
30 KiB
HTML
469 lines
30 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.hardware_support.managers package — vSphere Automation SDK for Python. 7.0.2.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 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.oauth2 package" href="com.vmware.oauth2.html" />
|
||
<link rel="prev" title="com.vmware.esx.settings.hardware_support package" href="com.vmware.esx.settings.hardware_support.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
7.0.2.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.oauth2_client">com.vmware.oauth2_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><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> »</li>
|
||
|
||
<li><a href="com.vmware.esx.settings.hardware_support.html">com.vmware.esx.settings.hardware_support package</a> »</li>
|
||
|
||
<li>com.vmware.esx.settings.hardware_support.managers package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.esx.settings.hardware_support.managers.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.hardware_support.managers">
|
||
<span id="com-vmware-esx-settings-hardware-support-managers-package"></span><h1>com.vmware.esx.settings.hardware_support.managers package<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support.managers" 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.hardware_support.managers.packages_client">
|
||
<span id="com-vmware-esx-settings-hardware-support-managers-packages-client-module"></span><h2>com.vmware.esx.settings.hardware_support.managers.packages_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support.managers.packages_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers.packages_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_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.hardware_support.managers.packages_client.Versions">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hardware_support.managers.packages_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_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 inspect a Hardware Support
|
||
Package (HSP)’s detailed information.</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.managers.packages_client.Versions.ComponentInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_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 HSP manifest.</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 HSP manifest.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_image_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.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">Versions.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when retrieving Hardware Support Packages (HSPs) information.</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>base_image_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>) – vSphere release version for the component information in the
|
||
Hardware Support Package (HSP). Only Hardware Support Packages
|
||
(HSPs) compatible with the vSphere release version specified in
|
||
‘baseImageVersion’ will be returned. The ‘baseImageVersion’
|
||
parameter should be a full numeric base image version string (e.g.
|
||
“7.1.0-2.3.436234”). Future implementations may support version
|
||
specification by prefix (e.g. “7.1” to specify all updates and
|
||
builds of 7.1) or other forms of specification (e.g. “>=7.0”).
|
||
Hardware Support Pacakges (HSPs) may be advertised as supporting
|
||
truncated version strings to indicate the remainder is wildcarded.
|
||
Matching is on the specified substring only, so a bundle supporting
|
||
“7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234”
|
||
as well as “7.1.0-2.1.4133564” and “7.1.0-2.0.355667” but not
|
||
“7.1.0-3.0.63445” or any base image version starting with “7.2”.
|
||
Note that we require compatible base image versions be specified at
|
||
least down to the update version (i.e. “7.0” is insufficiently
|
||
constrained)
|
||
If None, all supported releases will be returned but no specific
|
||
component information (added or deleted) will be included.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PackageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_releases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_components</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo" title="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.PackageInfo</span></code> class contains attributes that describe a
|
||
particular 3rd party Hardware Support Package (HSP)</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>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or
|
||
“Latest Hardware Support Package for Frobozz GenX hardware”)
|
||
selected
|
||
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.package</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.package</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 Hardware Support Package (e.g. “20180128.1” or
|
||
“v42”) selected</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Hardware Support Package (HSP) (e.g. for use in
|
||
help bubble)</p></li>
|
||
<li><p><strong>supported_releases</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>) – Supported vSphere releases</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.hardware_support.managers.packages_client.Versions.ComponentInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_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 HSP manifest.</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.hardware_support.managers.packages_client.Versions.RemovedComponentInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_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 HSP manifest.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.RemovedComponentInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RemovedComponentInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_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 HSP manifest.</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.hardware_support.managers.packages_client.Versions.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the detailed information for a specific version of an available
|
||
Hardware Support Packages (HSPs) as specified by the Hardware Support
|
||
Manager (HSM)</p>
|
||
<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>) – Identifier for the Hardware Support Manager (HSM).
|
||
The parameter 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>.</p></li>
|
||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the Hardware Support Package (HSP)
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the Hardware Support Package (HSP)</p></li>
|
||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of detailed information to be returned
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.FilterSpec</span></code></a> with all attributes None, which means
|
||
all releases supported are returned but no component information
|
||
for any particular release is included.</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.hardware_support.managers.packages_client.Versions.PackageInfo" title="com.vmware.esx.settings.hardware_support.managers.packages_client.Versions.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.PackageInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>detailed information on Hardware Support Packages (HSPs)</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.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 any of the specified parameters are Invalid (e.g. if the release
|
||
version specified in the query parameter is not, in fact, among
|
||
those supported by the Hardware Support Package (HSP).</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 Hardware Support Manager (HSM) with the specified
|
||
name, or no Hardware Support Package (HSP) with the specified name
|
||
and version.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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. named <code class="docutils literal notranslate"><span class="pre">manager</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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user does not have the required privilege to perform the
|
||
operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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.oauth2.html" class="btn btn-neutral float-right" title="com.vmware.oauth2 package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
<a href="com.vmware.esx.settings.hardware_support.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.hardware_support package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2021, VMware, Inc..
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |