Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 10:50:00 -05:00
Code
8ed6ef5a71
vsphere-automation-sdk-python/vsphere/7.0.0.1/com.vmware.appliance.html
anushah 633fe4c369 Documentation update for vSphere 7.0 GA
2020-04-08 16:55:51 +05:30

4688 lines
373 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>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.appliance package &mdash; vSphere Automation SDK for Python. 7.0.0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<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="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.appliance.networking package" href="com.vmware.appliance.networking.html" />
<link rel="prev" title="com.vmware package" href="com.vmware.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.0.1
</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">Docs</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>com.vmware.appliance package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.appliance.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.appliance">
<span id="com-vmware-appliance-package"></span><h1>com.vmware.appliance package<a class="headerlink" href="#module-com.vmware.appliance" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.firewall_client">com.vmware.appliance.networking.firewall_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.recovery.html">com.vmware.appliance.recovery package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html">com.vmware.appliance.recovery.backup package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.backup_client">com.vmware.appliance.recovery.backup_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.reconciliation_client">com.vmware.appliance.recovery.reconciliation_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.restore_client">com.vmware.appliance.recovery.restore_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.system.html">com.vmware.appliance.system package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.system.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.time_client">com.vmware.appliance.system.time_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.appliance.access_client">
<span id="com-vmware-appliance-access-client-module"></span><h2>com.vmware.appliance.access_client module<a class="headerlink" href="#module-com.vmware.appliance.access_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.access_client</span></code> module provides classes for managing
access to the appliance. The module is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Consolecli">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.access_client.</code><code class="sig-name descname">Consolecli</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Consolecli" 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><code class="docutils literal notranslate"><span class="pre">Consolecli</span></code> class provides methods Get/Set enabled state of CLI.</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="method">
<dt id="com.vmware.appliance.access_client.Consolecli.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Consolecli.get" title="Permalink to this definition"></a></dt>
<dd><p>Get enabled state of the console-based controlled CLI (TTY1).</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Console-based controlled CLI is enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Consolecli.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Consolecli.set" title="Permalink to this definition"></a></dt>
<dd><p>Set enabled state of the console-based controlled CLI (TTY1).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Console-based controlled CLI is enabled.</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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Dcui">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.access_client.</code><code class="sig-name descname">Dcui</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Dcui" 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><code class="docutils literal notranslate"><span class="pre">Dcui</span></code> class provides methods Get/Set enabled state of DCUI.</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="method">
<dt id="com.vmware.appliance.access_client.Dcui.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Dcui.get" title="Permalink to this definition"></a></dt>
<dd><p>Get enabled state of Direct Console User Interface (DCUI TTY2).</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>DCUI is enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Dcui.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Dcui.set" title="Permalink to this definition"></a></dt>
<dd><p>Set enabled state of Direct Console User Interface (DCUI TTY2).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – DCUI is enabled.</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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Shell">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.access_client.</code><code class="sig-name descname">Shell</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Shell" 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><code class="docutils literal notranslate"><span class="pre">Shell</span></code> class provides methods Get/Set enabled state of BASH.</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="class">
<dt id="com.vmware.appliance.access_client.Shell.ShellConfig">
<em class="property">class </em><code class="sig-name descname">ShellConfig</code><span class="sig-paren">(</span><em class="sig-param">enabled=None</em>, <em class="sig-param">timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Shell.ShellConfig" 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><code class="docutils literal notranslate"><span class="pre">Shell.ShellConfig</span></code> class Structure that defines shell configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enabled can be set to true or false</p></li>
<li><p><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The timeout (in seconds) specifies how long you enable the Shell
access. The maximum timeout is 86400 seconds(1 day).</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Shell.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Shell.get" title="Permalink to this definition"></a></dt>
<dd><p>Get enabled state of BASH, that is, access to BASH from within the
controlled CLI.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.access_client.Shell.ShellConfig" title="com.vmware.appliance.access_client.Shell.ShellConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shell.ShellConfig</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Current shell configuration.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Shell.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Shell.set" title="Permalink to this definition"></a></dt>
<dd><p>Set enabled state of BASH, that is, access to BASH from within the
controlled CLI.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.access_client.Shell.ShellConfig" title="com.vmware.appliance.access_client.Shell.ShellConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shell.ShellConfig</span></code></a>) – Shell configuration</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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Ssh">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.access_client.</code><code class="sig-name descname">Ssh</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Ssh" 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><code class="docutils literal notranslate"><span class="pre">Ssh</span></code> class provides methods Get/Set enabled state of SSH-based
controlled CLI.</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="method">
<dt id="com.vmware.appliance.access_client.Ssh.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Ssh.get" title="Permalink to this definition"></a></dt>
<dd><p>Get enabled state of the SSH-based controlled CLI.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>SSH-based controlled CLI is enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Ssh.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.Ssh.set" title="Permalink to this definition"></a></dt>
<dd><p>Set enabled state of the SSH-based controlled CLI.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – SSH-based controlled CLI is enabled.</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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.access_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.access_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.health_client">
<span id="com-vmware-appliance-health-client-module"></span><h2>com.vmware.appliance.health_client module<a class="headerlink" href="#module-com.vmware.appliance.health_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.health_client</span></code> module provides classes for
reporting the health of the various subsystems of the the appliance. The module
is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Applmgmt">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Applmgmt</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Applmgmt" 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><code class="docutils literal notranslate"><span class="pre">Applmgmt</span></code> class provides methods Get health status of applmgmt services.</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="method">
<dt id="com.vmware.appliance.health_client.Applmgmt.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Applmgmt.get" title="Permalink to this definition"></a></dt>
<dd><p>Get health status of applmgmt services.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>health status</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Databasestorage">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Databasestorage</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage" 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><code class="docutils literal notranslate"><span class="pre">Databasestorage</span></code> class provides methods Get database storage health.</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="class">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Databasestorage.HealthLevel</span></code> class Defines service health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy but experiencing some problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Databasestorage.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.get" title="Permalink to this definition"></a></dt>
<dd><p>Get database storage health.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel" title="com.vmware.appliance.health_client.Databasestorage.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Databasestorage.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Database storage health</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Load">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Load</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Load" 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><code class="docutils literal notranslate"><span class="pre">Load</span></code> class provides methods Get load health.</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="class">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Load.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Load.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Load.get" title="Permalink to this definition"></a></dt>
<dd><p>Get load health.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Load.HealthLevel" title="com.vmware.appliance.health_client.Load.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Load.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Load health.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Mem">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Mem</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Mem" 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><code class="docutils literal notranslate"><span class="pre">Mem</span></code> class provides methods Get memory health.</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="class">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Mem.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Mem.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.get" title="Permalink to this definition"></a></dt>
<dd><p>Get memory health.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Mem.HealthLevel" title="com.vmware.appliance.health_client.Mem.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mem.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Memory health.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Softwarepackages">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Softwarepackages</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages" 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><code class="docutils literal notranslate"><span class="pre">Softwarepackages</span></code> class provides methods Get information on available
software updates available in remote VUM repository.</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="class">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Softwarepackages.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Softwarepackages.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.get" title="Permalink to this definition"></a></dt>
<dd><p>Get information on available software updates available in the remote
vSphere Update Manager repository. Red indicates that security updates
are available. Orange indicates that non-security updates are
available. Green indicates that there are no updates available. Gray
indicates that there was an error retreiving information on software
updates.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel" title="com.vmware.appliance.health_client.Softwarepackages.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Softwarepackages.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>software updates available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Storage">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Storage</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Storage" 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><code class="docutils literal notranslate"><span class="pre">Storage</span></code> class provides methods Get storage health.</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="class">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Storage.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Storage.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.get" title="Permalink to this definition"></a></dt>
<dd><p>Get storage health.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Storage.HealthLevel" title="com.vmware.appliance.health_client.Storage.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Storage health.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_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="class">
<dt id="com.vmware.appliance.health_client.Swap">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">Swap</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Swap" 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><code class="docutils literal notranslate"><span class="pre">Swap</span></code> class provides methods Get swap health.</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="class">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">Swap.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.Swap.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.get" title="Permalink to this definition"></a></dt>
<dd><p>Get swap health.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.Swap.HealthLevel" title="com.vmware.appliance.health_client.Swap.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Swap.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Swap health</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.System">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.health_client.</code><code class="sig-name descname">System</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.System" 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><code class="docutils literal notranslate"><span class="pre">System</span></code> class provides methods Get overall health of the system.</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="class">
<dt id="com.vmware.appliance.health_client.System.HealthLevel">
<em class="property">class </em><code class="sig-name descname">HealthLevel</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel" 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><code class="docutils literal notranslate"><span class="pre">System.HealthLevel</span></code> class Defines health levels.</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">HealthLevel</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.gray">
<code class="sig-name descname">gray</code><em class="property"> = HealthLevel(string='gray')</em><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel.gray" title="Permalink to this definition"></a></dt>
<dd><p>No health data is available for this service.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.green">
<code class="sig-name descname">green</code><em class="property"> = HealthLevel(string='green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel.green" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.orange">
<code class="sig-name descname">orange</code><em class="property"> = HealthLevel(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel.orange" title="Permalink to this definition"></a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.red">
<code class="sig-name descname">red</code><em class="property"> = HealthLevel(string='red')</em><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel.red" title="Permalink to this definition"></a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
functioning soon.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.yellow">
<code class="sig-name descname">yellow</code><em class="property"> = HealthLevel(string='yellow')</em><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel.yellow" title="Permalink to this definition"></a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.System.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.System.get" title="Permalink to this definition"></a></dt>
<dd><p>Get overall health of system.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.health_client.System.HealthLevel" title="com.vmware.appliance.health_client.System.HealthLevel"><code class="xref py py-class docutils literal notranslate"><span class="pre">System.HealthLevel</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>System health</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.System.lastcheck">
<code class="sig-name descname">lastcheck</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.health_client.System.lastcheck" title="Permalink to this definition"></a></dt>
<dd><p>Get last check timestamp of the health of the system.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>System health last check timestamp</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.infraprofile_client">
<span id="com-vmware-appliance-infraprofile-client-module"></span><h2>com.vmware.appliance.infraprofile_client module<a class="headerlink" href="#module-com.vmware.appliance.infraprofile_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.infraprofile_client</span></code> module provides classes to
manage profile spec for the appliance</p>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.infraprofile_client.</code><code class="sig-name descname">Configs</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs" 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><code class="docutils literal notranslate"><span class="pre">Configs</span></code> class provides methods to manage desired configuration
specification of an appliance.</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="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec">
<em class="property">class </em><code class="sig-name descname">ImportProfileSpec</code><span class="sig-paren">(</span><em class="sig-param">config_spec=None</em>, <em class="sig-param">profile_spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec" 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">Configs.ImportProfileSpec</span></code> class represents a spec information for
import and validate.</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>config_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The JSON string representing the desired config specification.</p></li>
<li><p><strong>profile_spec</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec" title="com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ProfilesSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The profile specification, if any
only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is a profilespec avaliable for this
import profilespec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ProfileInfo">
<em class="property">class </em><code class="sig-name descname">ProfileInfo</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ProfileInfo" 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">Configs.ProfileInfo</span></code> class defines the information about profile.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the profile which is also a profile identifier.
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.infraprofile.profile</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.infraprofile.profile</span></code>.</p></li>
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the profile.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec">
<em class="property">class </em><code class="sig-name descname">ProfilesSpec</code><span class="sig-paren">(</span><em class="sig-param">encryption_key=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">profiles=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec" 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">Configs.ProfilesSpec</span></code> class represents a spec information for export
operation.</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>encryption_key</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>) – Encryption Key to encrypt/decrypt profiles.
If None encryption will not be used for the profile.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Custom description provided by the user.
If None description will be empty.</p></li>
<li><p><strong>profiles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Profiles to be exported/imported.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.infraprofile.profile</span></code>. When methods return a value of
this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.infraprofile.profile</span></code>.
If None or empty, all profiles will be returned.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ValidationResult">
<em class="property">class </em><code class="sig-name descname">ValidationResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">notifications=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ValidationResult" 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">Configs.ValidationResult</span></code> class contains attributes to describe
result of validation of profile specification.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ValidationStatus" title="com.vmware.appliance.infraprofile_client.Configs.ValidationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ValidationStatus</span></code></a>) – Status of the Profile spec.</p></li>
<li><p><strong>notifications</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Notifications" title="com.vmware.appliance.infraprofile_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications to the user
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the notifications were reported by this
particular validation.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ValidationStatus">
<em class="property">class </em><code class="sig-name descname">ValidationStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ValidationStatus" 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">Configs.ValidationStatus</span></code> class defines possible values of status of
profile spec.</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">ValidationStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ValidationStatus.INVALID">
<code class="sig-name descname">INVALID</code><em class="property"> = ValidationStatus(string='INVALID')</em><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ValidationStatus.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>Profile spec is invalid.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.infraprofile_client.Configs.ValidationStatus.VALID">
<code class="sig-name descname">VALID</code><em class="property"> = ValidationStatus(string='VALID')</em><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.ValidationStatus.VALID" title="Permalink to this definition"></a></dt>
<dd><p>Profile spec is valid.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.infraprofile_client.Configs.export">
<code class="sig-name descname">export</code><span class="sig-paren">(</span><em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.export" title="Permalink to this definition"></a></dt>
<dd><p>Exports the desired profile specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec" title="com.vmware.appliance.infraprofile_client.Configs.ProfilesSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ProfilesSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – information to export the profile.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Configuration specification JSON in string format.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no profile associated.</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>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.infraprofile_client.Configs.import_profile_task">
<code class="sig-name descname">import_profile_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.import_profile_task" title="Permalink to this definition"></a></dt>
<dd><p>Imports the desired profile specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec" title="com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ImportProfileSpec</span></code></a>) – information to import the profile.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no profile associated.</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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
If there is another operation in progress.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.infraprofile_client.Configs.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.list" title="Permalink to this definition"></a></dt>
<dd><p>List all the profiles which are registered.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.list" title="com.vmware.appliance.infraprofile_client.Configs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ProfileInfo" title="com.vmware.appliance.infraprofile_client.Configs.ProfileInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ProfileInfo</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of profiles with description are registered.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.infraprofile_client.Configs.validate_task">
<code class="sig-name descname">validate_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Configs.validate_task" title="Permalink to this definition"></a></dt>
<dd><p>Validates the desired profile specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec" title="com.vmware.appliance.infraprofile_client.Configs.ImportProfileSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configs.ImportProfileSpec</span></code></a>) – information to validate the profile.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no profile associated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Notification">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.infraprofile_client.</code><code class="sig-name descname">Notification</code><span class="sig-paren">(</span><em class="sig-param">notification=None</em>, <em class="sig-param">time=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">resolution=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Notification" 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">Notification</span></code> class contains attributes to describe any
info/warning/error messages that Tasks can raise.</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>notification</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification id.
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.infraprofile.notification</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.infraprofile.notification</span></code>.</p></li>
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The time the notification was raised/found.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the time information is available.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message.</p></li>
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.Notifications">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.infraprofile_client.</code><code class="sig-name descname">Notifications</code><span class="sig-paren">(</span><em class="sig-param">info=None</em>, <em class="sig-param">warnings=None</em>, <em class="sig-param">errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.Notifications" 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">Notifications</span></code> class contains info/warning/error messages that can
be reported be the task.</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>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Notification" title="com.vmware.appliance.infraprofile_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Notification" title="com.vmware.appliance.infraprofile_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Notification" title="com.vmware.appliance.infraprofile_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.infraprofile_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.infraprofile_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_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="class">
<dt id="com.vmware.appliance.infraprofile_client.TaskInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.infraprofile_client.</code><code class="sig-name descname">TaskInfo</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">notifications=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.infraprofile_client.TaskInfo" 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>
<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>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the operation.
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 one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>notifications</strong> (<a class="reference internal" href="#com.vmware.appliance.infraprofile_client.Notifications" title="com.vmware.appliance.infraprofile_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications to the user
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the notifications were reported by this
particular task.</p></li>
<li><p><strong>result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task result.
This attribute will be None if the task has no result.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
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.vapi.service</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.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
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.vapi.operation</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.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</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>) – Parent of the current task.
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.cis.task</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.cis.task</span></code>.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
If None the description of why the operation failed will be
included in the result of the operation (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
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 one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
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 one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>user</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>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.local_accounts_client">
<span id="com-vmware-appliance-local-accounts-client-module"></span><h2>com.vmware.appliance.local_accounts_client module<a class="headerlink" href="#module-com.vmware.appliance.local_accounts_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.appliance.local_accounts_client.Policy">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.local_accounts_client.</code><code class="sig-name descname">Policy</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.local_accounts_client.Policy" 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">Policy</span></code> class provides methods to manage local user accounts. This
class was added in vSphere API 6.7.</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="class">
<dt id="com.vmware.appliance.local_accounts_client.Policy.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">max_days=None</em>, <em class="sig-param">min_days=None</em>, <em class="sig-param">warn_days=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.local_accounts_client.Policy.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">Policy.Info</span></code> class defines the global password policy. This class
was added in vSphere API 6.7.</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>max_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days a password may be used. If the password is
older than this, a password change will be forced. This attribute
was added in vSphere API 6.7.
If None then the restriction will be ignored.</p></li>
<li><p><strong>min_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days allowed between password changes. Any
password changes attempted sooner than this will be rejected. This
attribute was added in vSphere API 6.7.
If None then the restriction will be ignored.</p></li>
<li><p><strong>warn_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days warning given before a password expires. A zero
means warning is given only upon the day of expiration. This
attribute was added in vSphere API 6.7.
If None then no warning will be provided.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.local_accounts_client.Policy.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.local_accounts_client.Policy.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the global password policy. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.local_accounts_client.Policy.Info" title="com.vmware.appliance.local_accounts_client.Policy.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Global password policy</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.local_accounts_client.Policy.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">policy</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.local_accounts_client.Policy.set" title="Permalink to this definition"></a></dt>
<dd><p>Set the global password policy. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>policy</strong> (<a class="reference internal" href="#com.vmware.appliance.local_accounts_client.Policy.Info" title="com.vmware.appliance.local_accounts_client.Policy.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Info</span></code></a>) – Global password policy</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed policy values are &lt; -1 or &gt; 99999</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.local_accounts_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.local_accounts_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.local_accounts_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.localaccounts_client">
<span id="com-vmware-appliance-localaccounts-client-module"></span><h2>com.vmware.appliance.localaccounts_client module<a class="headerlink" href="#module-com.vmware.appliance.localaccounts_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliancelocalaccounts</span></code> module provides classes for managing
local (OS) accounts in the appliance. The module is available starting in
vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.localaccounts_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.localaccounts_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.localaccounts_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.logging_client">
<span id="com-vmware-appliance-logging-client-module"></span><h2>com.vmware.appliance.logging_client module<a class="headerlink" href="#module-com.vmware.appliance.logging_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.logging_client</span></code> module provides classes for
managing log forwarding in the appliance. The module is available starting in
vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.logging_client.</code><code class="sig-name descname">Forwarding</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding" 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">Forwarding</span></code> class provides methods to manage forwarding of log
messages to remote logging servers. This class was added in vSphere API
6.7.</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="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.Config">
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">protocol=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.Config" 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">Forwarding.Config</span></code> class defines the configuration for log message
forwarding to remote logging servers. This class was added in vSphere API
6.7.</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>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN or IP address of the logging server to which messages are
forwarded. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The port on which the remote logging server is listening for
forwarded log messages. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.logging_client.Forwarding.Protocol" title="com.vmware.appliance.logging_client.Forwarding.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forwarding.Protocol</span></code></a>) – Transport protocol used to forward log messages. This attribute was
added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus">
<em class="property">class </em><code class="sig-name descname">ConnectionStatus</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus" 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>
<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>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN or IP address of the configured remote logging servers. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State" title="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forwarding.ConnectionStatus.State</span></code></a>) – State of the configured remote logging server. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message associated with the state of the configured remote logging
server. This attribute was added in vSphere API 6.7.
If None, there is no message to be shown.</p></li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State">
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State" 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">Forwarding.ConnectionStatus.State</span></code> class defines the state values
that a remote logging server can be in. This enumeration was added in
vSphere API 6.7.</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">State</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.DOWN">
<code class="sig-name descname">DOWN</code><em class="property"> = State(string='DOWN')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.DOWN" title="Permalink to this definition"></a></dt>
<dd><p>The remote logging server is not reachable. This class attribute was added
in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UNKNOWN">
<code class="sig-name descname">UNKNOWN</code><em class="property"> = State(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>The status of remote logging server is unknown. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UP">
<code class="sig-name descname">UP</code><em class="property"> = State(string='UP')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UP" title="Permalink to this definition"></a></dt>
<dd><p>The remote logging server is reachable. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.Protocol">
<em class="property">class </em><code class="sig-name descname">Protocol</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.Protocol" 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">Forwarding.Protocol</span></code> class defines transport protocols for outbound
log messages. This enumeration was added in vSphere API 6.7.</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">Protocol</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.Protocol.TCP">
<code class="sig-name descname">TCP</code><em class="property"> = Protocol(string='TCP')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.Protocol.TCP" title="Permalink to this definition"></a></dt>
<dd><p>Log messages will be forwarded to the remote host using the TCP protocol.
This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.Protocol.TLS">
<code class="sig-name descname">TLS</code><em class="property"> = Protocol(string='TLS')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.Protocol.TLS" title="Permalink to this definition"></a></dt>
<dd><p>Log messages will be forwarded to the remote host by using the TLS
protocol. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.Protocol.UDP">
<code class="sig-name descname">UDP</code><em class="property"> = Protocol(string='UDP')</em><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.Protocol.UDP" title="Permalink to this definition"></a></dt>
<dd><p>Log messages will be forwarded to the remote host using the UDP protocol.
This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.logging_client.Forwarding.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the configuration for forwarding log messages to remote logging
servers. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.logging_client.Forwarding.Config" title="com.vmware.appliance.logging_client.Forwarding.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forwarding.Config</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information about the configuration for forwarding log messages to
remote logging servers.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.logging_client.Forwarding.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">cfg_list</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets the configuration for forwarding log messages to remote log
servers. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cfg_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.logging_client.Forwarding.Config" title="com.vmware.appliance.logging_client.Forwarding.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forwarding.Config</span></code></a>) – The cfgList is a list of Config structure that contains the log
message forwarding rules in terms of the host, port, protocol of
the log message.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if an invalid configuration is provided.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the number of configurations exceeds the maximum number of
supported configurations.</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 any internal error during the execution of the
operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.logging_client.Forwarding.test">
<code class="sig-name descname">test</code><span class="sig-paren">(</span><em class="sig-param">send_test_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.Forwarding.test" title="Permalink to this definition"></a></dt>
<dd><p>Validates the current log forwarding configuration by checking the
liveness of the remote machine and optionally sending a test diagnostic
log message from the appliance to all configured logging servers to
allow manual end-to-end validation. The message that is sent is: “This
is a diagnostic log test message from vCenter Server.”. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>send_test_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag specifying whether a default test message should be sent to
the configured logging servers.
If None, no test message will be sent to the configured remote
logging servers.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus" title="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forwarding.ConnectionStatus</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the status of the connection to each of the
remote logging servers.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.logging_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.logging_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.monitoring_client">
<span id="com-vmware-appliance-monitoring-client-module"></span><h2>com.vmware.appliance.monitoring_client module<a class="headerlink" href="#module-com.vmware.appliance.monitoring_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring_client</span></code> module provides classes for
monitoring of the appliance. The module is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.monitoring_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.monitoring_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.monitoring_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.networking_client">
<span id="com-vmware-appliance-networking-client-module"></span><h2>com.vmware.appliance.networking_client module<a class="headerlink" href="#module-com.vmware.appliance.networking_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking_client</span></code> module provides classes for
managing network configuration of the appliance. The module is available
starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Interfaces">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces" 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><code class="docutils literal notranslate"><span class="pre">Interfaces</span></code> class provides methods Provides information about network
interface.</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="class">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo">
<em class="property">class </em><code class="sig-name descname">InterfaceInfo</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">mac=None</em>, <em class="sig-param">ipv4=None</em>, <em class="sig-param">ipv6=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" 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><code class="docutils literal notranslate"><span class="pre">Interfaces.InterfaceInfo</span></code> class Structure that defines properties and
status of a network interface.</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>) – Interface name, for example, “nic0”, “nic1”.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus" title="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.InterfaceStatus</span></code></a>) – Interface status.</p></li>
<li><p><strong>mac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – MAC address. For example 00:0C:29:94:BB:5A.</p></li>
<li><p><strong>ipv4</strong> (<a class="reference internal" href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv4.Info" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces_client.Ipv4.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv4 Address information. This attribute was added in vSphere API
6.7.
ipv4 This attribute will be None if IPv4 is not enabled.</p></li>
<li><p><strong>ipv6</strong> (<a class="reference internal" href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv6.Info" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces_client.Ipv6.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv6 Address information. This attribute was added in vSphere API
6.7.
ipv6 This attribute will be None if IPv6 is not enabled.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus">
<em class="property">class </em><code class="sig-name descname">InterfaceStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus" 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><code class="docutils literal notranslate"><span class="pre">Interfaces.InterfaceStatus</span></code> class Defines interface status</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">InterfaceStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.down">
<code class="sig-name descname">down</code><em class="property"> = InterfaceStatus(string='down')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.down" title="Permalink to this definition"></a></dt>
<dd><p>The interface is down.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.up">
<code class="sig-name descname">up</code><em class="property"> = InterfaceStatus(string='up')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.up" title="Permalink to this definition"></a></dt>
<dd><p>The interface is up.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Interfaces.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.get" title="Permalink to this definition"></a></dt>
<dd><p>Get information about a particular network interface.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Network interface, for example, “nic0”.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" title="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.InterfaceInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Network interface information.</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 the specified interface is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Interfaces.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.list" title="Permalink to this definition"></a></dt>
<dd><p>Get list of available network interfaces, including those that are not
yet configured.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.list" title="com.vmware.appliance.networking_client.Interfaces.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" title="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.InterfaceInfo</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of InterfaceInfo structures.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.NoProxy">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking_client.</code><code class="sig-name descname">NoProxy</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.NoProxy" 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">NoProxy</span></code> class provides methods to configure a connection that does
not need a proxy. This class was added in vSphere API 6.7.</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="method">
<dt id="com.vmware.appliance.networking_client.NoProxy.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.NoProxy.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns servers for which no proxy configuration will be applied. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of servers for which no proxy configuration will be applied.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.NoProxy.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.NoProxy.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets servers for which no proxy configuration should be applied. This
operation sets environment variables. In order for this operation to
take effect, a logout from appliance or a service restart is required.
If IPv4 is enabled, “127.0.0.1” and “localhost” will always bypass the
proxy (even if they are not explicitly configured). This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of strings representing servers to bypass proxy. A server can
be a FQDN, IP address, FQDN:port or IP:port combinations.</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>
Generic error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking_client.</code><code class="sig-name descname">Proxy</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy" 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">Proxy</span></code> class provides methods Proxy configuration. This class was
added in vSphere API 6.7.</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="class">
<dt id="com.vmware.appliance.networking_client.Proxy.Config">
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">server=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.Config" 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">Proxy.Config</span></code> class defines proxy configuration. This class was
added in vSphere API 6.7.</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>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the proxy server. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Port to connect to the proxy server. In a ‘get’ call, indicates the
port connected to the proxy server. In a ‘set’ call, specifies the
port to connect to the proxy server. A value of -1 indicates the
default port. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>username</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>) – Username for proxy server. This attribute was added in vSphere API
6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if proxy requires username.</p></li>
<li><p><strong>password</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>) – Password for proxy server. This attribute was added in vSphere API
6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if proxy requires password.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – In the result of the <code class="docutils literal notranslate"><span class="pre">#get</span></code> and <code class="docutils literal notranslate"><span class="pre">#list</span></code> methods this attribute
indicates whether proxying is enabled for a particular protocol. In
the input to the <code class="docutils literal notranslate"><span class="pre">test</span></code> and <code class="docutils literal notranslate"><span class="pre">set</span></code> methods this attribute
specifies whether proxying should be enabled for a particular
protocol. This attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol">
<em class="property">class </em><code class="sig-name descname">Protocol</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.Protocol" 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><code class="docutils literal notranslate"><span class="pre">Proxy.Protocol</span></code> class defines the protocols for which proxying is
supported. This enumeration was added in vSphere API 6.7.</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">Protocol</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol.FTP">
<code class="sig-name descname">FTP</code><em class="property"> = Protocol(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.Protocol.FTP" title="Permalink to this definition"></a></dt>
<dd><p>Proxy configuration for ftp. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol.HTTP">
<code class="sig-name descname">HTTP</code><em class="property"> = Protocol(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.Protocol.HTTP" title="Permalink to this definition"></a></dt>
<dd><p>Proxy configuration for http. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol.HTTPS">
<code class="sig-name descname">HTTPS</code><em class="property"> = Protocol(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.Protocol.HTTPS" title="Permalink to this definition"></a></dt>
<dd><p>Proxy configuration for https. This class attribute was added in vSphere
API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy.ServerStatus">
<em class="property">class </em><code class="sig-name descname">ServerStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.ServerStatus" 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><code class="docutils literal notranslate"><span class="pre">Proxy.ServerStatus</span></code> class defines the status of the server associated
with the test run. This enumeration was added in vSphere API 6.7.</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">ServerStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_REACHABLE">
<code class="sig-name descname">SERVER_REACHABLE</code><em class="property"> = ServerStatus(string='SERVER_REACHABLE')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_REACHABLE" title="Permalink to this definition"></a></dt>
<dd><p>Server is reachable. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_UNREACHABLE">
<code class="sig-name descname">SERVER_UNREACHABLE</code><em class="property"> = ServerStatus(string='SERVER_UNREACHABLE')</em><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_UNREACHABLE" title="Permalink to this definition"></a></dt>
<dd><p>Server is unreachable. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy.TestResult">
<em class="property">class </em><code class="sig-name descname">TestResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.TestResult" 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">Proxy.TestResult</span></code> class contains information about the test
operation done on a proxy server. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.ServerStatus" title="com.vmware.appliance.networking_client.Proxy.ServerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.ServerStatus</span></code></a>) – Status of the proxy server indicating whether the proxy server is
reachable. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message associated with status. This attribute was added in vSphere
API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">protocol</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a proxy configuration for a specific protocol. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID whose proxy is to be deleted.</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>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">protocol</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets the proxy configuration for a specific protocol. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The protocol whose proxy configuration is requested.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.Config" title="com.vmware.appliance.networking_client.Proxy.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.Config</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Proxy configuration for a specific protocol.</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>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.list" title="Permalink to this definition"></a></dt>
<dd><p>Gets proxy configuration for all configured protocols. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.Protocol" title="com.vmware.appliance.networking_client.Proxy.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.Protocol</span></code></a> and <a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.Config" title="com.vmware.appliance.networking_client.Proxy.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.Config</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Proxy configuration for all configured protocols.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">protocol</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.set" title="Permalink to this definition"></a></dt>
<dd><p>Configures which proxy server to use for the specified protocol. This
operation sets environment variables for using proxy. In order for this
configuration to take effect a logout / service restart is required.
This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The protocol for which proxy should be set.</p></li>
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.Config" title="com.vmware.appliance.networking_client.Proxy.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.Config</span></code></a>) – Proxy configuration for the specific protocol.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.test">
<code class="sig-name descname">test</code><span class="sig-paren">(</span><em class="sig-param">host</em>, <em class="sig-param">protocol</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.Proxy.test" title="Permalink to this definition"></a></dt>
<dd><p>Tests a proxy configuration by testing the connection to the proxy
server and test host. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</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>) – A hostname, IPv4 or Ipv6 address.</p></li>
<li><p><strong>protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Protocol whose proxy is to be tested.</p></li>
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.Config" title="com.vmware.appliance.networking_client.Proxy.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.Config</span></code></a>) – Proxy configuration to test.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking_client.Proxy.TestResult" title="com.vmware.appliance.networking_client.Proxy.TestResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Proxy.TestResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Status of proxy settings.</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>
Generic error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.ntp_client">
<span id="com-vmware-appliance-ntp-client-module"></span><h2>com.vmware.appliance.ntp_client module<a class="headerlink" href="#module-com.vmware.appliance.ntp_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.ntp_client</span></code> module provides classes for managing
NTP settings of the appliance. The module is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.ntp_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.ntp_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.ntp_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.recovery_client">
<span id="com-vmware-appliance-recovery-client-module"></span><h2>com.vmware.appliance.recovery_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery_client</span></code> module provides classes for backin
up and restoring vCenter Appliance configuration. The module is available
starting in vSphere 6.7.</p>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery_client.</code><code class="sig-name descname">Backup</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup" 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><code class="docutils literal notranslate"><span class="pre">Backup</span></code> class provides methods Performs backup restore operations</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.BackupRequest">
<em class="property">class </em><code class="sig-name descname">BackupRequest</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.BackupRequest" 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><code class="docutils literal notranslate"><span class="pre">Backup.BackupRequest</span></code> class Structure representing requested backup
piece</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>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a list of optional parts. Run backup parts APIs to get list of
optional parts and description</p></li>
<li><p><strong>backup_password</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>) – a password for a backup piece The backupPassword must adhere to the
following password requirements: At least 8 characters, cannot be
more than 20 characters in length. At least 1 uppercase letter. At
least 1 lowercase letter. At least 1 numeric digit. At least 1
special character (i.e. any character not in [0-9,a-z,A-Z]). Only
visible ASCII characters (for example, no space).
backupPassword If no password then the piece will not be encrypted</p></li>
<li><p><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.LocationType" title="com.vmware.appliance.recovery_client.Backup.LocationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backup.LocationType</span></code></a>) – a type of location</p></li>
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – path or url</p></li>
<li><p><strong>location_user</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>) – username for location
locationUser User name for this location if login is required.</p></li>
<li><p><strong>location_password</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>) – password for location
locationPassword Password for the specified user if login is
required at this location.</p></li>
<li><p><strong>comment</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>) – Custom comment
comment an optional comment</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.LocalizableMessage">
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocalizableMessage" 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><code class="docutils literal notranslate"><span class="pre">Backup.LocalizableMessage</span></code> class Structure representing message</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – id in message bundle</p></li>
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – text in english</p></li>
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – nested data</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType">
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType" 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><code class="docutils literal notranslate"><span class="pre">Backup.LocationType</span></code> class Defines type of all locations for
backup/restore</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">LocationType</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.FTP">
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.FTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.FTPS">
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.FTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.HTTP">
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.HTTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.HTTPS">
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.HTTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.NFS">
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.NFS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
6.7.2.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.SCP">
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.SCP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SSH server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.SFTP">
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.SFTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SFTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.SMB">
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType.SMB" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
6.7.2.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnResult">
<em class="property">class </em><code class="sig-name descname">ReturnResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnResult" 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><code class="docutils literal notranslate"><span class="pre">Backup.ReturnResult</span></code> class Structure representing precheck result</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus" title="com.vmware.appliance.recovery_client.Backup.ReturnStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backup.ReturnStatus</span></code></a>) – Check status</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.LocalizableMessage" title="com.vmware.appliance.recovery_client.Backup.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backup.LocalizableMessage</span></code></a>) – List of messages</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus">
<em class="property">class </em><code class="sig-name descname">ReturnStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus" 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><code class="docutils literal notranslate"><span class="pre">Backup.ReturnStatus</span></code> class Defines the state of precheck</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">ReturnStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus.FAIL">
<code class="sig-name descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.FAIL" title="Permalink to this definition"></a></dt>
<dd><p>Check failed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus.OK">
<code class="sig-name descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.OK" title="Permalink to this definition"></a></dt>
<dd><p>Check passed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus.WARNING">
<code class="sig-name descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Passed with warnings</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery_client.Backup.validate">
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.validate" title="Permalink to this definition"></a></dt>
<dd><p>Check for backup errors without starting backup.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>piece</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.BackupRequest" title="com.vmware.appliance.recovery_client.Backup.BackupRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backup.BackupRequest</span></code></a>) – BackupRequest Structure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.ReturnResult" title="com.vmware.appliance.recovery_client.Backup.ReturnResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backup.ReturnResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>ReturnResult Structure</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.FeatureInUse" title="com.vmware.vapi.std.errors_client.FeatureInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code></a>
A backup or restore is already in progress</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery_client.</code><code class="sig-name descname">Restore</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore" 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><code class="docutils literal notranslate"><span class="pre">Restore</span></code> class provides methods Performs restore operations</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.LocalizableMessage">
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocalizableMessage" 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><code class="docutils literal notranslate"><span class="pre">Restore.LocalizableMessage</span></code> class Structure representing message</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – id in message bundle</p></li>
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – text in english</p></li>
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – nested data</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType">
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType" 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><code class="docutils literal notranslate"><span class="pre">Restore.LocationType</span></code> class Defines type of all locations for
backup/restore</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">LocationType</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.FTP">
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.FTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.FTPS">
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.FTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.HTTP">
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.HTTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.HTTPS">
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.HTTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.NFS">
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.NFS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
6.7.2.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.SCP">
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.SCP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SSH server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.SFTP">
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.SFTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SFTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.SMB">
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType.SMB" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
6.7.2.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.Metadata">
<em class="property">class </em><code class="sig-name descname">Metadata</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">parts=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">boxname=None</em>, <em class="sig-param">sso_login_required=None</em>, <em class="sig-param">comment=None</em>, <em class="sig-param">applicable=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.Metadata" 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><code class="docutils literal notranslate"><span class="pre">Restore.Metadata</span></code> class Structure representing metadata</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>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was completed.</p></li>
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of parts included in the backup.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – VCSA version</p></li>
<li><p><strong>boxname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Box name is PNID/ FQDN etc</p></li>
<li><p><strong>sso_login_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is SSO login required for the vCenter server. This attribute was
added in vSphere API 6.7.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment</p></li>
<li><p><strong>applicable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Does the VCSA match the deployment type, network properties and
version of backed up VC</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.LocalizableMessage" title="com.vmware.appliance.recovery_client.Restore.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Restore.LocalizableMessage</span></code></a>) – Any messages if the backup is not aplicable</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.RestoreRequest">
<em class="property">class </em><code class="sig-name descname">RestoreRequest</code><span class="sig-paren">(</span><em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">sso_admin_user_name=None</em>, <em class="sig-param">sso_admin_user_password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.RestoreRequest" 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><code class="docutils literal notranslate"><span class="pre">Restore.RestoreRequest</span></code> class Structure representing requested restore
piece</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>backup_password</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>) – a password for a backup piece
backupPassword If no password then the piece will not be decrypted</p></li>
<li><p><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.LocationType" title="com.vmware.appliance.recovery_client.Restore.LocationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Restore.LocationType</span></code></a>) – a type of location</p></li>
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – path or url</p></li>
<li><p><strong>location_user</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>) – username for location
locationUser User name for this location if login is required.</p></li>
<li><p><strong>location_password</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>) – password for location
locationPassword Password for the specified user if login is
required at this location.</p></li>
<li><p><strong>sso_admin_user_name</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>) – Administrators username for SSO. This attribute was added in
vSphere API 6.7.
If None SSO authentication will not be used. If the vCenter Server
is a management node or an embedded node, authentication is
required.</p></li>
<li><p><strong>sso_admin_user_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The password for SSO admin user. This attribute was added in
vSphere API 6.7.
If None SSO authentication will not be used. If the vCenter Server
is a management node or an embedded node, authentication is
required.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery_client.Restore.validate">
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.validate" title="Permalink to this definition"></a></dt>
<dd><p>Get metadata before restore</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>piece</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.RestoreRequest" title="com.vmware.appliance.recovery_client.Restore.RestoreRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">Restore.RestoreRequest</span></code></a>) – RestoreRequest Structure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.Metadata" title="com.vmware.appliance.recovery_client.Restore.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Restore.Metadata</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Metadata Structure</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>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.shutdown_client">
<span id="com-vmware-appliance-shutdown-client-module"></span><h2>com.vmware.appliance.shutdown_client module<a class="headerlink" href="#module-com.vmware.appliance.shutdown_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.shutdown_client</span></code> module provides classes to
shutdown and reboot the appliance. The module is available starting in vSphere
6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.shutdown_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.shutdown_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.shutdown_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.system_client">
<span id="com-vmware-appliance-system-client-module"></span><h2>com.vmware.appliance.system_client module<a class="headerlink" href="#module-com.vmware.appliance.system_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.system_client</span></code> module provides classes to query the
appliance system information. The module is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Storage">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system_client.</code><code class="sig-name descname">Storage</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage" 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><code class="docutils literal notranslate"><span class="pre">Storage</span></code> class provides methods Appliance storage configuration</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="class">
<dt id="com.vmware.appliance.system_client.Storage.StorageChange">
<em class="property">class </em><code class="sig-name descname">StorageChange</code><span class="sig-paren">(</span><em class="sig-param">old_size=None</em>, <em class="sig-param">new_size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.StorageChange" 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">Storage.StorageChange</span></code> class describes the changes in capasity of a
storage partition. This class was added in vSphere API 6.7.</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>old_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Original size of the partition in MB. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>new_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Nedw size of the partition in MB. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Storage.StorageMapping">
<em class="property">class </em><code class="sig-name descname">StorageMapping</code><span class="sig-paren">(</span><em class="sig-param">disk=None</em>, <em class="sig-param">partition=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.StorageMapping" 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">Storage.StorageMapping</span></code> class describes the mapping between VCSA
partitions and the Hard disk numbers visible in the vSphere Web Client.</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>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The disk number in the vSphere Web Client.
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.appliance.system.storage</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.appliance.system.storage</span></code>.</p></li>
<li><p><strong>partition</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage partition name.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of partition. This attribute was added in vSphere API
6.7.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.list" title="Permalink to this definition"></a></dt>
<dd><p>Get disk to partition mapping.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.system_client.Storage.list" title="com.vmware.appliance.system_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.system_client.Storage.StorageMapping" title="com.vmware.appliance.system_client.Storage.StorageMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.StorageMapping</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>list of mapping items</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.resize">
<code class="sig-name descname">resize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.resize" title="Permalink to this definition"></a></dt>
<dd><p>Resize all partitions to 100 percent of disk size.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.resize_ex">
<code class="sig-name descname">resize_ex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.resize_ex" title="Permalink to this definition"></a></dt>
<dd><p>Resize all partitions to 100 percent of disk size. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.system_client.Storage.StorageChange" title="com.vmware.appliance.system_client.Storage.StorageChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.StorageChange</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of the partitions with the size before and after resizing</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_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="class">
<dt id="com.vmware.appliance.system_client.Time">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system_client.</code><code class="sig-name descname">Time</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Time" 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><code class="docutils literal notranslate"><span class="pre">Time</span></code> class provides methods Gets system time.</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="class">
<dt id="com.vmware.appliance.system_client.Time.SystemTimeStruct">
<em class="property">class </em><code class="sig-name descname">SystemTimeStruct</code><span class="sig-paren">(</span><em class="sig-param">seconds_since_epoch=None</em>, <em class="sig-param">date=None</em>, <em class="sig-param">time=None</em>, <em class="sig-param">timezone=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Time.SystemTimeStruct" 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><code class="docutils literal notranslate"><span class="pre">Time.SystemTimeStruct</span></code> class Structure representing the system time.</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>seconds_since_epoch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – seconds since the epoch</p></li>
<li><p><strong>date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – date format: Thu 07-31-2014</p></li>
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – time format: 18:18:32</p></li>
<li><p><strong>timezone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – timezone</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Time.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Time.get" title="Permalink to this definition"></a></dt>
<dd><p>Get system time.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.system_client.Time.SystemTimeStruct" title="com.vmware.appliance.system_client.Time.SystemTimeStruct"><code class="xref py py-class docutils literal notranslate"><span class="pre">Time.SystemTimeStruct</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>System time</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Uptime">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system_client.</code><code class="sig-name descname">Uptime</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Uptime" 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><code class="docutils literal notranslate"><span class="pre">Uptime</span></code> class provides methods Get the system uptime.</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="method">
<dt id="com.vmware.appliance.system_client.Uptime.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Uptime.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the system uptime.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>system uptime</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Version">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system_client.</code><code class="sig-name descname">Version</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Version" 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><code class="docutils literal notranslate"><span class="pre">Version</span></code> class provides methods Get the appliance version.</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="class">
<dt id="com.vmware.appliance.system_client.Version.VersionStruct">
<em class="property">class </em><code class="sig-name descname">VersionStruct</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">product=None</em>, <em class="sig-param">build=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">summary=None</em>, <em class="sig-param">releasedate=None</em>, <em class="sig-param">install_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Version.VersionStruct" 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><code class="docutils literal notranslate"><span class="pre">Version.VersionStruct</span></code> class Structure representing appliance version
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"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance version.</p></li>
<li><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance name.</p></li>
<li><p><strong>build</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance build number.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of product. Same product can have different deployment
options, which is represented by type.</p></li>
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Summary of patch (empty string, if the appliance has not been
patched)</p></li>
<li><p><strong>releasedate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Release date of patch (empty string, if the appliance has not been
patched)</p></li>
<li><p><strong>install_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display the date and time when this system was first installed.
Value will not change on subsequent updates.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Version.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system_client.Version.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the version.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.system_client.Version.VersionStruct" title="com.vmware.appliance.system_client.Version.VersionStruct"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version.VersionStruct</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>version information about the appliance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.tymesync_client">
<span id="com-vmware-appliance-tymesync-client-module"></span><h2>com.vmware.appliance.tymesync_client module<a class="headerlink" href="#module-com.vmware.appliance.tymesync_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.tymesync_client</span></code> module provides classes for
managing tyme synchronization settings of the appliance. The module is
available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.tymesync_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.tymesync_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.tymesync_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.update_client">
<span id="com-vmware-appliance-update-client-module"></span><h2>com.vmware.appliance.update_client module<a class="headerlink" href="#module-com.vmware.appliance.update_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update_client</span></code> module provides classes for updating
the software in the appliance. The module is available starting in vSphere 6.5.</p>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">CommonInfo</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">priority=None</em>, <em class="sig-param">severity=None</em>, <em class="sig-param">update_type=None</em>, <em class="sig-param">release_date=None</em>, <em class="sig-param">reboot_required=None</em>, <em class="sig-param">size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo" 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">CommonInfo</span></code> class defines common update information. This class was
added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>priority</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Priority" title="com.vmware.appliance.update_client.CommonInfo.Priority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Severity" title="com.vmware.appliance.update_client.CommonInfo.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Category" title="com.vmware.appliance.update_client.CommonInfo.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>reboot_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category">
<em class="property">class </em><code class="sig-name descname">Category</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Category" 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">CommonInfo.Category</span></code> class defines update type. This enumeration was
added in vSphere API 6.7.</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">Category</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.FIX">
<code class="sig-name descname">FIX</code><em class="property"> = Category(string='FIX')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Category.FIX" title="Permalink to this definition"></a></dt>
<dd><p>Fixes bugs/vulnerabilities, doesn’t change functionality. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.SECURITY">
<code class="sig-name descname">SECURITY</code><em class="property"> = Category(string='SECURITY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Category.SECURITY" title="Permalink to this definition"></a></dt>
<dd><p>Fixes vulnerabilities, doesn’t change functionality. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.UPDATE">
<code class="sig-name descname">UPDATE</code><em class="property"> = Category(string='UPDATE')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Category.UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>Changes product functionality. This class attribute was added in vSphere
API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.UPGRADE">
<code class="sig-name descname">UPGRADE</code><em class="property"> = Category(string='UPGRADE')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Category.UPGRADE" title="Permalink to this definition"></a></dt>
<dd><p>Introduces new features, significantly changes product functionality. This
class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority">
<em class="property">class </em><code class="sig-name descname">Priority</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Priority" 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">CommonInfo.Priority</span></code> class defines the update installation priority
recommendations. This enumeration was added in vSphere API 6.7.</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">Priority</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.HIGH">
<code class="sig-name descname">HIGH</code><em class="property"> = Priority(string='HIGH')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Priority.HIGH" title="Permalink to this definition"></a></dt>
<dd><p>Install ASAP. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.LOW">
<code class="sig-name descname">LOW</code><em class="property"> = Priority(string='LOW')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Priority.LOW" title="Permalink to this definition"></a></dt>
<dd><p>Install at your discretion. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.MEDIUM">
<code class="sig-name descname">MEDIUM</code><em class="property"> = Priority(string='MEDIUM')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Priority.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Install at the earliest convenience. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity">
<em class="property">class </em><code class="sig-name descname">Severity</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Severity" 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">CommonInfo.Severity</span></code> class defines the severity of the issues fixed
in the update. This enumeration was added in vSphere API 6.7.</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">Severity</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.CRITICAL">
<code class="sig-name descname">CRITICAL</code><em class="property"> = Severity(string='CRITICAL')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Severity.CRITICAL" title="Permalink to this definition"></a></dt>
<dd><p>Vulnerabilities that can be exploited by an unauthenticated attacker from
the Internet or those that break the guest/host Operating System isolation.
The exploitation results in the complete compromise of confidentiality,
integrity, and availability of user data and/or processing resources
without user interaction. Exploitation could be leveraged to propagate an
Internet worm or execute arbitrary code between Virtual Machines and/or the
Host Operating System. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.IMPORTANT">
<code class="sig-name descname">IMPORTANT</code><em class="property"> = Severity(string='IMPORTANT')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Severity.IMPORTANT" title="Permalink to this definition"></a></dt>
<dd><p>Vulnerabilities that are not rated critical but whose exploitation results
in the complete compromise of confidentiality and/or integrity of user data
and/or processing resources through user assistance or by authenticated
attackers. This rating also applies to those vulnerabilities which could
lead to the complete compromise of availability when exploitation is by a
remote unauthenticated attacker from the Internet or through a breach of
virtual machine isolation. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.LOW">
<code class="sig-name descname">LOW</code><em class="property"> = Severity(string='LOW')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Severity.LOW" title="Permalink to this definition"></a></dt>
<dd><p>All other issues that have a security impact. Vulnerabilities where
exploitation is believed to be extremely difficult, or where successful
exploitation would have minimal impact. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.MODERATE">
<code class="sig-name descname">MODERATE</code><em class="property"> = Severity(string='MODERATE')</em><a class="headerlink" href="#com.vmware.appliance.update_client.CommonInfo.Severity.MODERATE" title="Permalink to this definition"></a></dt>
<dd><p>Vulnerabilities where the ability to exploit is mitigated to a significant
degree by configuration or difficulty of exploitation, but in certain
deployment scenarios could still lead to the compromise of confidentiality,
integrity, or availability of user data and/or processing resources. This
class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">Pending</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending" 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">Pending</span></code> class provides methods to manipulate pending updates. This
class was added in vSphere API 6.7.</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="class">
<dt id="com.vmware.appliance.update_client.Pending.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">contents=None</em>, <em class="sig-param">services_will_be_stopped=None</em>, <em class="sig-param">eulas=None</em>, <em class="sig-param">staged=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">priority=None</em>, <em class="sig-param">severity=None</em>, <em class="sig-param">update_type=None</em>, <em class="sig-param">release_date=None</em>, <em class="sig-param">reboot_required=None</em>, <em class="sig-param">size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.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">Pending.Info</span></code> class contains the extended information about the
update. This class was added in vSphere API 6.7.</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>contents</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of the 1. issues addressed since previous/current version 2.
new features/improvements. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>services_will_be_stopped</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.update_client.ServiceInfo" title="com.vmware.appliance.update_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a>) – List of the services that will be stopped and restarted during the
update installation. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>eulas</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of EULAs. This list has multiple entries and can be dynamic
based on what we are actually installing. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>staged</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is the update staged. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>priority</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Priority" title="com.vmware.appliance.update_client.CommonInfo.Priority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Severity" title="com.vmware.appliance.update_client.CommonInfo.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Category" title="com.vmware.appliance.update_client.CommonInfo.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>reboot_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.PrecheckResult">
<em class="property">class </em><code class="sig-name descname">PrecheckResult</code><span class="sig-paren">(</span><em class="sig-param">check_time=None</em>, <em class="sig-param">estimated_time_to_install=None</em>, <em class="sig-param">estimated_time_to_rollback=None</em>, <em class="sig-param">reboot_required=None</em>, <em class="sig-param">issues=None</em>, <em class="sig-param">questions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.PrecheckResult" 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">Pending.PrecheckResult</span></code> class contains estimates of how long it will
take install and rollback an update as well as a list of possible warnings
and problems with installing the update. This class was added in vSphere
API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>check_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this precheck was run. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>estimated_time_to_install</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rough estimate of time to install the update (minutes). This
attribute was added in vSphere API 6.7.
estimatedTimeToInstall If None N/A</p></li>
<li><p><strong>estimated_time_to_rollback</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rough estimate of time to rollback the update (minutes). This
attribute was added in vSphere API 6.7.
estimatedTimeToRollback If None N/A</p></li>
<li><p><strong>reboot_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is reboot required to install the update. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>issues</strong> (<a class="reference internal" href="com.vmware.html#com.vmware.appliance_client.Notifications" title="com.vmware.appliance_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists of the issues and warnings. This attribute was added in
vSphere API 6.7.
issues If None N/A</p></li>
<li><p><strong>questions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.update_client.Pending.Question" title="com.vmware.appliance.update_client.Pending.Question"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.Question</span></code></a>) – List of questions that must be answered to install the update. This
attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.Question">
<em class="property">class </em><code class="sig-name descname">Question</code><span class="sig-paren">(</span><em class="sig-param">data_item=None</em>, <em class="sig-param">text=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">allowed_values=None</em>, <em class="sig-param">regexp=None</em>, <em class="sig-param">default_answer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.Question" 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">Pending.Question</span></code> class describes a item of information that must be
provided by the user in order to install the update. This class was added
in vSphere API 6.7.</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>data_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the data item. This attribute was added in vSphere API 6.7.
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.applicance.update.pending.dataitem</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.applicance.update.pending.dataitem</span></code>.</p></li>
<li><p><strong>text</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Label for the item to be used in GUI/CLI. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the item. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.Pending.Question.InputType" title="com.vmware.appliance.update_client.Pending.Question.InputType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.Question.InputType</span></code></a>) – How this field shoudl be represented in GUI or CLI. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>allowed_values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of allowed values. This attribute was added in vSphere API
6.7.
allowedValues If None any value is valid.</p></li>
<li><p><strong>regexp</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>) – Regexp to validate the input. This attribute was added in vSphere
API 6.7.
regexp If None no validation will be performed.</p></li>
<li><p><strong>default_answer</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>) – Default answer. This attribute was added in vSphere API 6.7.
defaultAnswer If None then there is no default answer, so an
explicit answer must be provided</p></li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType">
<em class="property">class </em><code class="sig-name descname">InputType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.Question.InputType" 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">Pending.Question.InputType</span></code> class defines representation of field
fields in GUI or CLI. This enumeration was added in vSphere API 6.7.</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">InputType</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.BOOLEAN">
<code class="sig-name descname">BOOLEAN</code><em class="property"> = InputType(string='BOOLEAN')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.Question.InputType.BOOLEAN" title="Permalink to this definition"></a></dt>
<dd><p>Yes/No,On/Off,Checkbox answer. This class attribute was added in vSphere
API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.PASSWORD">
<code class="sig-name descname">PASSWORD</code><em class="property"> = InputType(string='PASSWORD')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.Question.InputType.PASSWORD" title="Permalink to this definition"></a></dt>
<dd><p>Password (masked) answer. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.PLAIN_TEXT">
<code class="sig-name descname">PLAIN_TEXT</code><em class="property"> = InputType(string='PLAIN_TEXT')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.Question.InputType.PLAIN_TEXT" title="Permalink to this definition"></a></dt>
<dd><p>plain text answer. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.SourceType">
<em class="property">class </em><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.SourceType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Pending.SourceType</span></code> class defines the supported types of sources of
updates. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LAST_CHECK">
<code class="sig-name descname">LAST_CHECK</code><em class="property"> = SourceType(string='LAST_CHECK')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.SourceType.LAST_CHECK" title="Permalink to this definition"></a></dt>
<dd><p>Do not perform a new check, return the previous result. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LOCAL">
<code class="sig-name descname">LOCAL</code><em class="property"> = SourceType(string='LOCAL')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.SourceType.LOCAL" title="Permalink to this definition"></a></dt>
<dd><p>Check the local sources, ISO devices, staged area. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LOCAL_AND_ONLINE">
<code class="sig-name descname">LOCAL_AND_ONLINE</code><em class="property"> = SourceType(string='LOCAL_AND_ONLINE')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.SourceType.LOCAL_AND_ONLINE" title="Permalink to this definition"></a></dt>
<dd><p>Check the local sources, ISO devices, staged area, then online repository
as stated in update policy. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets update information. This method was added in vSphere API 6.7.</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>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.update_client.Pending.Info" title="com.vmware.appliance.update_client.Pending.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Update</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>
Generic error</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>
session 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>
session is not authorized to perform this operation</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>
the update 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.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the update of this version is already installed</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.install">
<code class="sig-name descname">install</code><span class="sig-paren">(</span><em class="sig-param">version</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.install" title="Permalink to this definition"></a></dt>
<dd><p>Starts operation of installing the appliance update. Will fail is the
update is not staged. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p></li>
<li><p><strong>user_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for
the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.applicance.update.pending.dataitem</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this 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.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 update is not found</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the update of this version is already installed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance update state prevents running an update or not staged</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">source_type</em>, <em class="sig-param">url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.list" title="Permalink to this definition"></a></dt>
<dd><p>Checks if new updates are available. This method was added in vSphere
API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.Pending.SourceType" title="com.vmware.appliance.update_client.Pending.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.SourceType</span></code></a>) – type of the source</p></li>
<li><p><strong>url</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>) – specific URL to check at
If None then URL is taken from the policy settings</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.update_client.Pending.list" title="com.vmware.appliance.update_client.Pending.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.update_client.Summary" title="com.vmware.appliance.update_client.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of the update summaries</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>
Generic error</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>
source 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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this operation</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.precheck">
<code class="sig-name descname">precheck</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.precheck" title="Permalink to this definition"></a></dt>
<dd><p>Runs update precheck. This method was added in vSphere API 6.7.</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>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.update_client.Pending.PrecheckResult" title="com.vmware.appliance.update_client.Pending.PrecheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pending.PrecheckResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>PrecheckResult</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>
Generic error</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>
session 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>
session is not authorized to perform this operation</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>
the update 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.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if this version is already installed</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if another operation is in progress</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.stage">
<code class="sig-name descname">stage</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.stage" title="Permalink to this definition"></a></dt>
<dd><p>Starts staging the appliance update. The updates are searched for in
the following order: staged, CDROM, URL. This method was added in
vSphere API 6.7.</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>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</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>
session 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>
session is not authorized to perform this operation</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>
the update 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.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the update of this version is already installed</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
the update is already staged</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance update state prevents staging</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.stage_and_install">
<code class="sig-name descname">stage_and_install</code><span class="sig-paren">(</span><em class="sig-param">version</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.stage_and_install" title="Permalink to this definition"></a></dt>
<dd><p>Starts operation of installing the appliance update. Will stage update
if not already staged The updates are searched for in the following
order: staged, CDROM, URL. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p></li>
<li><p><strong>user_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for
the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.applicance.update.pending.dataitem</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this 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.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 update is not found</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the update of this version is already installed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance update state prevents running an update</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.validate">
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param">version</em>, <em class="sig-param">user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Pending.validate" title="Permalink to this definition"></a></dt>
<dd><p>Validates the user provided data before the update installation. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Update version
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.update.pending</span></code>.</p></li>
<li><p><strong>user_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for
the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.applicance.update.pending.dataitem</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.html#com.vmware.appliance_client.Notifications" title="com.vmware.appliance_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance_client.Notifications</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Issues struct with the issues found during the validation</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>
Generic error</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>
session 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>
session is not authorized to perform this operation</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 the update 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.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the update of this version is already installed</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance update state prevents running an check</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">Policy</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy" 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">Policy</span></code> class provides methods to set/get background check for the
new updates. This class was added in vSphere API 6.7.</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="class">
<dt id="com.vmware.appliance.update_client.Policy.Config">
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">custom_url=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">check_schedule=None</em>, <em class="sig-param">auto_stage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.Config" 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">Policy.Config</span></code> class defines automatic update checking and staging
policy. This class was added in vSphere API 6.7.</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>custom_url</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>) – Current appliance update repository URL. This attribute was added
in vSphere API 6.7.
If None then default URL is assumed</p></li>
<li><p><strong>username</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>) – Username for the update repository. This attribute was added in
vSphere API 6.7.
If None username will not be used to login</p></li>
<li><p><strong>password</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>) – Password for the update repository. This attribute was added in
vSphere API 6.7.
password If None password will not be used to login</p></li>
<li><p><strong>check_schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.update_client.Policy.Time" title="com.vmware.appliance.update_client.Policy.Time"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Time</span></code></a>) – Schedule when the automatic check will be run. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>auto_stage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Automatically stage the latest update if available. This attribute
was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek">
<em class="property">class </em><code class="sig-name descname">DayOfWeek</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.DayOfWeek</span></code> class defines the set of days. This enumeration
was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.FRIDAY">
<code class="sig-name descname">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.FRIDAY" title="Permalink to this definition"></a></dt>
<dd><p>Friday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.MONDAY">
<code class="sig-name descname">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.MONDAY" title="Permalink to this definition"></a></dt>
<dd><p>Monday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.SATURDAY">
<code class="sig-name descname">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.SATURDAY" title="Permalink to this definition"></a></dt>
<dd><p>Saturday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.SUNDAY">
<code class="sig-name descname">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.SUNDAY" title="Permalink to this definition"></a></dt>
<dd><p>Sunday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.THURSDAY">
<code class="sig-name descname">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.THURSDAY" title="Permalink to this definition"></a></dt>
<dd><p>Thursday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.TUESDAY">
<code class="sig-name descname">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.TUESDAY" title="Permalink to this definition"></a></dt>
<dd><p>Tuesday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.WEDNESDAY">
<code class="sig-name descname">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</em><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.DayOfWeek.WEDNESDAY" title="Permalink to this definition"></a></dt>
<dd><p>Wednesday. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">custom_url=None</em>, <em class="sig-param">default_url=None</em>, <em class="sig-param">username=None</em>, <em class="sig-param">check_schedule=None</em>, <em class="sig-param">auto_stage=None</em>, <em class="sig-param">auto_update=None</em>, <em class="sig-param">manual_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.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">Policy.Info</span></code> class defines automatic update checking and staging
policy. This class was added in vSphere API 6.7.</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>custom_url</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>) – Current appliance update custom repository URL. This attribute was
added in vSphere API 6.7.
If None update is checked at defaut URL.</p></li>
<li><p><strong>default_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current appliance update default repository URL. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>username</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>) – Username for the update repository. This attribute was added in
vSphere API 6.7.
If None username will not be used to login</p></li>
<li><p><strong>check_schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.update_client.Policy.Time" title="com.vmware.appliance.update_client.Policy.Time"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Time</span></code></a>) – Schedule when the automatic check will be run. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>auto_stage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Automatically stage the latest update if available. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>auto_update</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is the appliance updated automatically. If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> the
appliance may ignore the check schedule or auto-stage settings.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>manual_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether API client should allow the user to start update manually.
This attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.Time">
<em class="property">class </em><code class="sig-name descname">Time</code><span class="sig-paren">(</span><em class="sig-param">day=None</em>, <em class="sig-param">hour=None</em>, <em class="sig-param">minute=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.Time" 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">Policy.Time</span></code> class defines weekday and time the automatic check for
new updates will be run. This class was added in vSphere API 6.7.</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>day</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.Policy.DayOfWeek" title="com.vmware.appliance.update_client.Policy.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.DayOfWeek</span></code></a>) – weekday to check for updates. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Hour: 0-24. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minute: 0-59. This attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Policy.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets the automatic update checking and staging policy. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.update_client.Policy.Info" title="com.vmware.appliance.update_client.Policy.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Structure containing the policy for the appliance update.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this operation</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Policy.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">policy</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Policy.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets the automatic update checking and staging policy. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>policy</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.Policy.Config" title="com.vmware.appliance.update_client.Policy.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Config</span></code></a>) – Info structure containing the policy for the appliance update.</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>
Generic error</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>
session 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>
session is not authorized to perform this operation</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.ServiceInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">ServiceInfo</code><span class="sig-paren">(</span><em class="sig-param">service=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.ServiceInfo" 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">ServiceInfo</span></code> class describes a service to be stopped and started
during the update installation. This class was added in vSphere API 6.7.</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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service ID. This attribute was added in vSphere API 6.7.
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.appliance.service</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.appliance.service</span></code>.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Service description. This attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Staged">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">Staged</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Staged" 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">Staged</span></code> class provides methods to get the status of the staged
update. This class was added in vSphere API 6.7.</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="class">
<dt id="com.vmware.appliance.update_client.Staged.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">staging_complete=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">priority=None</em>, <em class="sig-param">severity=None</em>, <em class="sig-param">update_type=None</em>, <em class="sig-param">release_date=None</em>, <em class="sig-param">reboot_required=None</em>, <em class="sig-param">size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Staged.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">Staged.Info</span></code> class contains information about the staged update.
This class was added in vSphere API 6.7.</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>staging_complete</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is staging complete. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was
added in vSphere API 6.7.
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.appliance.update.pending</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.appliance.update.pending</span></code>.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>priority</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Priority" title="com.vmware.appliance.update_client.CommonInfo.Priority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Severity" title="com.vmware.appliance.update_client.CommonInfo.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Category" title="com.vmware.appliance.update_client.CommonInfo.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>reboot_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Staged.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Staged.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the staged update. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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>
Generic error</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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this operation</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Staged.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Staged.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets the current status of the staged update. This method was added in
vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.update_client.Staged.Info" title="com.vmware.appliance.update_client.Staged.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Staged.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Info structure with information about staged update</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</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>
session is not authenticated</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
session is not authorized to perform this 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if nothing is staged</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_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="class">
<dt id="com.vmware.appliance.update_client.Summary">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.update_client.</code><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">priority=None</em>, <em class="sig-param">severity=None</em>, <em class="sig-param">update_type=None</em>, <em class="sig-param">release_date=None</em>, <em class="sig-param">reboot_required=None</em>, <em class="sig-param">size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.update_client.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary</span></code> class contains the essential information about the update.
This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was
added in vSphere API 6.7.
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.appliance.update.pending</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.appliance.update.pending</span></code>.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>priority</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Priority" title="com.vmware.appliance.update_client.CommonInfo.Priority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Severity" title="com.vmware.appliance.update_client.CommonInfo.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>update_type</strong> (<a class="reference internal" href="#com.vmware.appliance.update_client.CommonInfo.Category" title="com.vmware.appliance.update_client.CommonInfo.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>reboot_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.vmon_client">
<span id="com-vmware-appliance-vmon-client-module"></span><h2>com.vmware.appliance.vmon_client module<a class="headerlink" href="#module-com.vmware.appliance.vmon_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon_client</span></code> module provides classes to manage a
set of services that are part of the vCenter Server.</p>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vmon_client.</code><code class="sig-name descname">Service</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service" 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">Service</span></code> class provides methods to manage a single/set of services
that are managed by vMon.</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="class">
<dt id="com.vmware.appliance.vmon_client.Service.Health">
<em class="property">class </em><code class="sig-name descname">Health</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Health" 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">Service.Health</span></code> class defines the possible values for health of a
service.</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">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.Health.DEGRADED">
<code class="sig-name descname">DEGRADED</code><em class="property"> = Health(string='DEGRADED')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Health.DEGRADED" title="Permalink to this definition"></a></dt>
<dd><p>Service is in degraded state, it is not functional.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.Health.HEALTHY">
<code class="sig-name descname">HEALTHY</code><em class="property"> = Health(string='HEALTHY')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Health.HEALTHY" title="Permalink to this definition"></a></dt>
<dd><p>Service is in a healthy state and is fully functional.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.Health.HEALTHY_WITH_WARNINGS">
<code class="sig-name descname">HEALTHY_WITH_WARNINGS</code><em class="property"> = Health(string='HEALTHY_WITH_WARNINGS')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Health.HEALTHY_WITH_WARNINGS" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy with warnings.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name_key=None</em>, <em class="sig-param">description_key=None</em>, <em class="sig-param">startup_type=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">health=None</em>, <em class="sig-param">health_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.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">Service.Info</span></code> class contains information about a service.</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_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service name key. Can be used to lookup resource bundle</p></li>
<li><p><strong>description_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service description key. Can be used to lookup resource bundle</p></li>
<li><p><strong>startup_type</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType" title="com.vmware.appliance.vmon_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a>) – Startup Type.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State" title="com.vmware.appliance.vmon_client.Service.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.State</span></code></a>) – Running State.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.Health" title="com.vmware.appliance.vmon_client.Service.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Health</span></code></a>) – Health of service.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State.STARTED" title="com.vmware.appliance.vmon_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
<li><p><strong>health_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable messages associated with the health of the service
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State.STARTED" title="com.vmware.appliance.vmon_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType">
<em class="property">class </em><code class="sig-name descname">StartupType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.StartupType" 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">Service.StartupType</span></code> class defines valid Startup Type for services
managed by vMon.</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">StartupType</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType.AUTOMATIC">
<code class="sig-name descname">AUTOMATIC</code><em class="property"> = StartupType(string='AUTOMATIC')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.StartupType.AUTOMATIC" title="Permalink to this definition"></a></dt>
<dd><p>Service Startup type is Automatic, thus during starting all services or
issuing explicit start on the service will start it.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED">
<code class="sig-name descname">DISABLED</code><em class="property"> = StartupType(string='DISABLED')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>Service Startup type is Disabled, thus it will not start unless the startup
type changes to manual or automatic.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType.MANUAL">
<code class="sig-name descname">MANUAL</code><em class="property"> = StartupType(string='MANUAL')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.StartupType.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>Service Startup type is Manual, thus issuing an explicit start on the
service will start it.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service.State">
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State" 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">Service.State</span></code> class defines valid Run State for services.</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">State</span></code> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.State.STARTED">
<code class="sig-name descname">STARTED</code><em class="property"> = State(string='STARTED')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State.STARTED" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Started, it is fully functional</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.State.STARTING">
<code class="sig-name descname">STARTING</code><em class="property"> = State(string='STARTING')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State.STARTING" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Starting, it is still not functional</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.State.STOPPED">
<code class="sig-name descname">STOPPED</code><em class="property"> = State(string='STOPPED')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State.STOPPED" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Stopped</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.State.STOPPING">
<code class="sig-name descname">STOPPING</code><em class="property"> = State(string='STOPPING')</em><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State.STOPPING" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Stopping, it is not functional</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service.UpdateSpec">
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">startup_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.UpdateSpec</span></code> class describes the changes to be made to the
configuration of the service.</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>startup_type</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType" title="com.vmware.appliance.vmon_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Startup Type
If unspecified, leaves value unchanged.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the state of a service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service whose state is being queried.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.Info" title="com.vmware.appliance.vmon_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Service Info structure.</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 the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.list_details">
<code class="sig-name descname">list_details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.list_details" title="Permalink to this definition"></a></dt>
<dd><p>Lists details of services managed by vMon.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.Info" title="com.vmware.appliance.vmon_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Map of service identifiers to service Info structures.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 any error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.restart">
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.restart" title="Permalink to this definition"></a></dt>
<dd><p>Restarts a service</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to restart
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
if any timeout occurs during the execution of the restart
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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation is denied in the current state of the service. If
a stop or start operation is in progress, issuing a restart
operation will lead to this error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a restart operation is issued on a service which has startup
type <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED" title="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.start" title="Permalink to this definition"></a></dt>
<dd><p>Starts a service</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to start
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation is denied in the current state of the service. If
a stop or restart operation is in progress, the start operation
will not be allowed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if start operation is issued on a service which has startup type
<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED" title="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
if any timeout occurs during the execution of the start operation.
Timeout occurs when the service takes longer than StartTimeout to
start.</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 any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.stop">
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.stop" title="Permalink to this definition"></a></dt>
<dd><p>Stops a service</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to stop
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation is denied in the current state of the service. If
a stop operation is in progress, issuing another stop operation
will lead to this error.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">service</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the properties of a service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service whose properties are being updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vmon.Service</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.UpdateSpec" title="com.vmware.appliance.vmon_client.Service.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.UpdateSpec</span></code></a>) – Service Update specification.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation is denied in the current state of the service. If
a start, stop or restart operation is in progress, update operation
will fail with this error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a request to set the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.UpdateSpec.startup_type</span></code>
attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> to <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED" title="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a> comes
in for a service that is not in <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State.STOPPED" title="com.vmware.appliance.vmon_client.Service.State.STOPPED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STOPPED</span></code></a>
state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vmon_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vmon_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.appliance.networking.html" class="btn btn-neutral float-right" title="com.vmware.appliance.networking package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.html" class="btn btn-neutral float-left" title="com.vmware 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>
View Git Blame Copy Permalink