Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
44eb68437b
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.host.html
bhagatp10 44eb68437b
Updated VC docs for v8.0.3.0 (#424) 
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>

Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 17:44:27 +05:30

406 lines
36 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.host package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.hvc package" href="com.vmware.vcenter.hvc.html" />
<link rel="prev" title="com.vmware.vcenter.deployment.install.initial_config package" href="com.vmware.vcenter.deployment.install.initial_config.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.host package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.host.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-com.vmware.vcenter.host">
<span id="com-vmware-vcenter-host-package"></span><h1>com.vmware.vcenter.host package<a class="headerlink" href="#module-com.vmware.vcenter.host" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.vcenter.host.entropy_client">
<span id="com-vmware-vcenter-host-entropy-client-module"></span><h2>com.vmware.vcenter.host.entropy_client module<a class="headerlink" href="#module-com.vmware.vcenter.host.entropy_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.host.entropy_client</span></code> module provides classes to
manage entropy</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.host.entropy_client.</span></span><span class="sig-name descname"><span class="pre">ExternalPool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExternalPool</span></code> class provides methods to send entropy data and query
external entropy pool information on an ESX host. Clients can check the
entropy level of an ESX host using the <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.get" title="com.vmware.vcenter.host.entropy_client.ExternalPool.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.get()</span></code></a> method to
check . When the entropy level has dropped below a threshold, a client can
use the <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method to add additional entropy until as
required. This class was added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.AddResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AddResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</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">currently_available</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">low_watermark</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">inactive_source_timeout</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.vcenter.host.entropy_client.ExternalPool.AddResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExternalPool.AddResult</span></code> class provides result of the
<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method. This class was added in vSphere API
8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Capacity of external entropy pool in bytes. This attribute was
added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>currently_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Currently available amount of entropy in bytes in the external
entropy pool. This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>low_watermark</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – A threshold value in bytes. An audit record will be logged when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.AddResult.currently_available</span></code> drops below this
value. This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>inactive_source_timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>A timeout period in seconds within which the client must call
<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.get" title="com.vmware.vcenter.host.entropy_client.ExternalPool.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.get()</span></code></a> method or <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method.
If no call is received before the timeout lapses an audit record
will be created.</p>
<p>This is the timeout to detect any connection lost with the client..
This attribute was added in vSphere API 8.0.1.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.AddSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AddSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</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.vcenter.host.entropy_client.ExternalPool.AddSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExternalPool.AddSpec</span></code> class defines parameters for the
<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method. This class was added in vSphere API
8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Buffer for entropy data. This will carry entropy data received from
the external entropy source. This attribute was added in vSphere
API 8.0.1.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</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">capacity</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">currently_available</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">low_watermark</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">inactive_source_timeout</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.vcenter.host.entropy_client.ExternalPool.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExternalPool.Info</span></code> class contains entropy pool information on the
ESX host. It provides external entropy pool details as well as timeout in
seconds within which client has to keep calling <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.get" title="com.vmware.vcenter.host.entropy_client.ExternalPool.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.get()</span></code></a>
method.</p>
<p>Client has to monitor Info.currentlyAvailable parameter. Before the entropy
level goes down below a threshold value the client has to send entropy data
by calling <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method.. This class was added in
vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalPool.Status</span></code></a>) – This flag indicates entropy service is enabled or not in a ESX
host. This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Capacity of external entropy pool in bytes. This attribute was
added in vSphere API 8.0.1.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Status.ENABLED</span></code></a>.</p></li>
<li><p><strong>currently_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Currently available amount of entropy in bytes in the external
entropy pool. This attribute was added in vSphere API 8.0.1.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Status.ENABLED</span></code></a>.</p></li>
<li><p><strong>low_watermark</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – A threshold value in bytes. An audit record will be logged when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Info.currently_available</span></code> drops below this
value. This attribute was added in vSphere API 8.0.1.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Status.ENABLED</span></code></a>.</p></li>
<li><p><strong>inactive_source_timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>A timeout period in seconds within which the client must call
<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.get" title="com.vmware.vcenter.host.entropy_client.ExternalPool.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.get()</span></code></a> method or <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="com.vmware.vcenter.host.entropy_client.ExternalPool.add"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalPool.add()</span></code></a> method.
If no call is received before the timeout lapses an audit record
will be created.</p>
<p>This timeout is used to detect that connection with the client is
lost.. This attribute was added in vSphere API 8.0.1.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Status.ENABLED</span></code></a>.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExternalPool.Status</span></code> enum represents external entropy status on an
ESX host. This enumeration was added in vSphere API 8.0.1.0.</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="bora/vspherevmodl2/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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.DISABLED">
<span class="sig-name descname"><span class="pre">DISABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>External entropy is disabled for the ESX host. This class attribute was
added in vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED">
<span class="sig-name descname"><span class="pre">ENABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ENABLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Status.ENABLED" title="Permalink to this definition"></a></dt>
<dd><p>External entropy is enabled for the ESX host. This class attribute was
added in vSphere API 8.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.add" title="Permalink to this definition"></a></dt>
<dd><p>Adds additional entropy to the pool. This API will accept maximum
(<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Info.capacity</span></code> -
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalPool.Info.currently_available</span></code>) bytes of entropy. Extra
entropy data sent will be discarded. This method was added in vSphere
API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.AddSpec" title="com.vmware.vcenter.host.entropy_client.ExternalPool.AddSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalPool.AddSpec</span></code></a>) – contains buffer of entropy data.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.AddResult" title="com.vmware.vcenter.host.entropy_client.ExternalPool.AddResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalPool.AddResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Result of <code class="docutils literal notranslate"><span class="pre">add</span></code> method.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the host is not found.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the host is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Entropy.Write</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.ExternalPool.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the entropy pool details of a host including current entropy
level. This method was added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.host.entropy_client.ExternalPool.Info" title="com.vmware.vcenter.host.entropy_client.ExternalPool.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalPool.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Entropy details of a host.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the host is not found.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the host is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Entropy.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.host.entropy_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.host.entropy_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.host.entropy_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment.install.initial_config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.hvc.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.hvc package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink