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/6.7.0/com.vmware.appliance.html
Tianhao He 9bf9af8207 add vsphere, vmc and nsx API docs
2018-08-07 16:42:25 -07:00

3434 lines
241 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 6.7.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="vSphere Automation SDK for Python 6.7.0 documentation" href="index.html"/>
<link rel="up" title="com.vmware package" href="com.vmware.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"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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">
6.7.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_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" role="navigation" 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.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="descclassname">com.vmware.appliance.access_client.</code><code class="descname">Consolecli</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.access_client.Consolecli.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Console-based controlled CLI is enabled.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Consolecli.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Console-based controlled CLI is enabled.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Dcui">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.access_client.</code><code class="descname">Dcui</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.access_client.Dcui.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DCUI is enabled.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Dcui.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – DCUI is enabled.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Shell">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.access_client.</code><code class="descname">Shell</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.access_client.Shell.ShellConfig">
<em class="property">class </em><code class="descname">ShellConfig</code><span class="sig-paren">(</span><em>enabled=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Shell.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Current shell configuration.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Shell.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.Ssh">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.access_client.</code><code class="descname">Ssh</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.access_client.Ssh.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SSH-based controlled CLI is enabled.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.access_client.Ssh.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – SSH-based controlled CLI is enabled.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.access_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.access_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Applmgmt</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.health_client.Applmgmt.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">health status</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Databasestorage">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Databasestorage</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Database storage health</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Load">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Load</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Load health.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Mem">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Mem</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Memory health.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Softwarepackages">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Softwarepackages</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">software updates available.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Storage">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Storage</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Storage health.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.Swap">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">Swap</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Swap health</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.health_client.System">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.health_client.</code><code class="descname">System</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.health_client.System.HealthLevel">
<em class="property">class </em><code class="descname">HealthLevel</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.health_client.System.HealthLevel.gray">
<code class="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="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="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">System health</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.health_client.System.lastcheck">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">System health last check timestamp</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</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="descclassname">com.vmware.appliance.local_accounts_client.</code><code class="descname">Policy</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.local_accounts_client.Policy.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>max_days=None</em>, <em>min_days=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.local_accounts_client.Policy.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Global password policy</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.local_accounts_client.Policy.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
if passed policy values are &lt; -1 or &gt; 99999</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.local_accounts_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.local_accounts_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.localaccounts_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.logging_client.</code><code class="descname">Forwarding</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.Config">
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>port=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus">
<em class="property">class </em><code class="descname">ConnectionStatus</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>state=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State">
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.DOWN">
<code class="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="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="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="descname">Protocol</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.logging_client.Forwarding.Protocol.TCP">
<code class="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="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="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="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Information about the configuration for forwarding log messages to
remote logging servers.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.logging_client.Forwarding.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
if an invalid configuration is provided.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
if the number of configurations exceeds the maximum number of
supported configurations.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if there is any internal error during the execution of the
operation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.logging_client.Forwarding.test">
<code class="descname">test</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the status of the connection to each of the
remote logging servers.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.logging_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.logging_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.monitoring_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.networking_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo">
<em class="property">class </em><code class="descname">InterfaceInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>status=None</em>, <em>mac=None</em>, <em>ipv4=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus">
<em class="property">class </em><code class="descname">InterfaceStatus</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.down">
<code class="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="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="descname">get</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Network interface information.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the specified interface is not found.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Interfaces.list">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of InterfaceInfo structures.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.NoProxy">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking_client.</code><code class="descname">NoProxy</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.networking_client.NoProxy.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of servers for which no proxy configuration will be applied.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.NoProxy.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking_client.</code><code class="descname">Proxy</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.networking_client.Proxy.Config">
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>server=None</em>, <em>port=None</em>, <em>username=None</em>, <em>password=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol">
<em class="property">class </em><code class="descname">Protocol</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.Protocol.FTP">
<code class="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="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="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="descname">ServerStatus</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_REACHABLE">
<code class="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="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="descname">TestResult</code><span class="sig-paren">(</span><em>status=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Proxy configuration for a specific protocol.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.list">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Proxy configuration for all configured protocols.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>protocol</em>, <em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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.</li>
<li><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.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.networking_client.Proxy.test">
<code class="descname">test</code><span class="sig-paren">(</span><em>host</em>, <em>protocol</em>, <em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A hostname, IPv4 or Ipv6 address.</li>
<li><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.</li>
<li><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.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Status of proxy settings.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.networking_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.ntp_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.recovery_client.</code><code class="descname">Backup</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.recovery_client.Backup.BackupRequest">
<em class="property">class </em><code class="descname">BackupRequest</code><span class="sig-paren">(</span><em>parts=None</em>, <em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.LocalizableMessage">
<em class="property">class </em><code class="descname">LocalizableMessage</code><span class="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType">
<em class="property">class </em><code class="descname">LocationType</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.FTP">
<code class="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="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="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="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.SCP">
<code class="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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnResult">
<em class="property">class </em><code class="descname">ReturnResult</code><span class="sig-paren">(</span><em>status=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus">
<em class="property">class </em><code class="descname">ReturnStatus</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus.FAIL">
<code class="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="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="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="descname">validate</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">ReturnResult Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code>
A backup or restore is already in progress</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery_client.</code><code class="descname">Restore</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.recovery_client.Restore.LocalizableMessage">
<em class="property">class </em><code class="descname">LocalizableMessage</code><span class="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType">
<em class="property">class </em><code class="descname">LocationType</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.FTP">
<code class="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="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="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="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.SCP">
<code class="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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.Metadata">
<em class="property">class </em><code class="descname">Metadata</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>parts=None</em>, <em>version=None</em>, <em>boxname=None</em>, <em>sso_login_required=None</em>, <em>comment=None</em>, <em>applicable=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.Restore.RestoreRequest">
<em class="property">class </em><code class="descname">RestoreRequest</code><span class="sig-paren">(</span><em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>sso_admin_user_name=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery_client.Restore.validate">
<code class="descname">validate</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Metadata Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.shutdown_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.system_client.</code><code class="descname">Storage</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.system_client.Storage.StorageChange">
<em class="property">class </em><code class="descname">StorageChange</code><span class="sig-paren">(</span><em>old_size=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Storage.StorageMapping">
<em class="property">class </em><code class="descname">StorageMapping</code><span class="sig-paren">(</span><em>disk=None</em>, <em>partition=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.list">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of mapping items</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.resize">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Storage.resize_ex">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of the partitions with the size before and after resizing</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Time">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system_client.</code><code class="descname">Time</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.system_client.Time.SystemTimeStruct">
<em class="property">class </em><code class="descname">SystemTimeStruct</code><span class="sig-paren">(</span><em>seconds_since_epoch=None</em>, <em>date=None</em>, <em>time=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Time.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">System time</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Uptime">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system_client.</code><code class="descname">Uptime</code><span class="sig-paren">(</span><em>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="method">
<dt id="com.vmware.appliance.system_client.Uptime.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">system uptime</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.system_client.Version">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system_client.</code><code class="descname">Version</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.system_client.Version.VersionStruct">
<em class="property">class </em><code class="descname">VersionStruct</code><span class="sig-paren">(</span><em>version=None</em>, <em>product=None</em>, <em>build=None</em>, <em>type=None</em>, <em>summary=None</em>, <em>releasedate=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.system_client.Version.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">version information about the appliance</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
</tbody>
</table>
</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="descclassname">com.vmware.appliance.tymesync_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</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="descclassname">com.vmware.appliance.update_client.</code><code class="descname">CommonInfo</code><span class="sig-paren">(</span><em>description=None</em>, <em>priority=None</em>, <em>severity=None</em>, <em>update_type=None</em>, <em>release_date=None</em>, <em>reboot_required=None</em>, <em>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</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category">
<em class="property">class </em><code class="descname">Category</code><span class="sig-paren">(</span><em>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</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.FIX">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.SECURITY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.UPDATE">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Category.UPGRADE">
<code class="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</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority">
<em class="property">class </em><code class="descname">Priority</code><span class="sig-paren">(</span><em>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.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.HIGH">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.LOW">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Priority.MEDIUM">
<code class="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</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity">
<em class="property">class </em><code class="descname">Severity</code><span class="sig-paren">(</span><em>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.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.CRITICAL">
<code class="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.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.IMPORTANT">
<code class="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.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.LOW">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.CommonInfo.Severity.MODERATE">
<code class="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.</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="descclassname">com.vmware.appliance.update_client.</code><code class="descname">Pending</code><span class="sig-paren">(</span><em>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.</p>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>contents=None</em>, <em>services_will_be_stopped=None</em>, <em>eulas=None</em>, <em>staged=None</em>, <em>description=None</em>, <em>priority=None</em>, <em>severity=None</em>, <em>update_type=None</em>, <em>release_date=None</em>, <em>reboot_required=None</em>, <em>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</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.PrecheckResult">
<em class="property">class </em><code class="descname">PrecheckResult</code><span class="sig-paren">(</span><em>check_time=None</em>, <em>estimated_time_to_install=None</em>, <em>estimated_time_to_rollback=None</em>, <em>reboot_required=None</em>, <em>issues=None</em>, <em>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.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.Question">
<em class="property">class </em><code class="descname">Question</code><span class="sig-paren">(</span><em>data_item=None</em>, <em>text=None</em>, <em>description=None</em>, <em>type=None</em>, <em>allowed_values=None</em>, <em>regexp=None</em>, <em>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.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType">
<em class="property">class </em><code class="descname">InputType</code><span class="sig-paren">(</span><em>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</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.BOOLEAN">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.PASSWORD">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.Question.InputType.PLAIN_TEXT">
<code class="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</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="descname">SourceType</code><span class="sig-paren">(</span><em>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.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LAST_CHECK">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LOCAL">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Pending.SourceType.LOCAL_AND_ONLINE">
<code class="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</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Update</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
the update is not found</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if the update of this version is already installed</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.install">
<code class="descname">install</code><span class="sig-paren">(</span><em>version</em>, <em>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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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>.</li>
<li><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>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the update is not found</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if the update of this version is already installed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if appliance update state prevents running an update or not staged</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.list">
<code class="descname">list</code><span class="sig-paren">(</span><em>source_type</em>, <em>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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</li>
<li><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</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">List of the update summaries</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
source is not found</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.precheck">
<code class="descname">precheck</code><span class="sig-paren">(</span><em>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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">PrecheckResult</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
the update is not found</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if this version is already installed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if another operation is in progress</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.stage">
<code class="descname">stage</code><span class="sig-paren">(</span><em>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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
the update is not found</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if the update of this version is already installed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
the update is already staged</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if appliance update state prevents staging</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.stage_and_install">
<code class="descname">stage_and_install</code><span class="sig-paren">(</span><em>version</em>, <em>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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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>.</li>
<li><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>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the update is not found</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if the update of this version is already installed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if appliance update state prevents running an update</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Pending.validate">
<code class="descname">validate</code><span class="sig-paren">(</span><em>version</em>, <em>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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>.</li>
<li><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>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Issues struct with the issues found during the validation</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the update is not found</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
if the update of this version is already installed</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if appliance update state prevents running an check</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.update_client.</code><code class="descname">Policy</code><span class="sig-paren">(</span><em>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.</p>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.Config">
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>custom_url=None</em>, <em>username=None</em>, <em>password=None</em>, <em>check_schedule=None</em>, <em>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.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek">
<em class="property">class </em><code class="descname">DayOfWeek</code><span class="sig-paren">(</span><em>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</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.FRIDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.MONDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.SATURDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.SUNDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.THURSDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.TUESDAY">
<code class="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</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.update_client.Policy.DayOfWeek.WEDNESDAY">
<code class="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</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>custom_url=None</em>, <em>default_url=None</em>, <em>username=None</em>, <em>check_schedule=None</em>, <em>auto_stage=None</em>, <em>auto_update=None</em>, <em>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.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Policy.Time">
<em class="property">class </em><code class="descname">Time</code><span class="sig-paren">(</span><em>day=None</em>, <em>hour=None</em>, <em>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</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Policy.get">
<code class="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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Structure containing the policy for the appliance update.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Policy.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.ServiceInfo">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.update_client.</code><code class="descname">ServiceInfo</code><span class="sig-paren">(</span><em>service=None</em>, <em>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.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Staged">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.update_client.</code><code class="descname">Staged</code><span class="sig-paren">(</span><em>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.</p>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Staged.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>staging_complete=None</em>, <em>version=None</em>, <em>description=None</em>, <em>priority=None</em>, <em>severity=None</em>, <em>update_type=None</em>, <em>release_date=None</em>, <em>reboot_required=None</em>, <em>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</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Staged.delete">
<code class="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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.update_client.Staged.get">
<code class="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</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Info structure with information about staged update</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
session is not authenticated</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
session is not authorized to perform this operation</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
if nothing is staged</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.update_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.update_client.Summary">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.update_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>version=None</em>, <em>description=None</em>, <em>priority=None</em>, <em>severity=None</em>, <em>update_type=None</em>, <em>release_date=None</em>, <em>reboot_required=None</em>, <em>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</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</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="descclassname">com.vmware.appliance.vmon_client.</code><code class="descname">Service</code><span class="sig-paren">(</span><em>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="class">
<dt id="com.vmware.appliance.vmon_client.Service.Health">
<em class="property">class </em><code class="descname">Health</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.Health.DEGRADED">
<code class="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="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="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="descname">Info</code><span class="sig-paren">(</span><em>name_key=None</em>, <em>description_key=None</em>, <em>startup_type=None</em>, <em>state=None</em>, <em>health=None</em>, <em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType">
<em class="property">class </em><code class="descname">StartupType</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.StartupType.AUTOMATIC">
<code class="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="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="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="descname">State</code><span class="sig-paren">(</span><em>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="first admonition-title">Note</p>
<p class="last">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="attribute">
<dt id="com.vmware.appliance.vmon_client.Service.State.STARTED">
<code class="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="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="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="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="descname">UpdateSpec</code><span class="sig-paren">(</span><em>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="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Service Info structure.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any other error occurs during the execution of the operation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.list_details">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">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>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any error occurs during the execution of the operation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.restart">
<code class="descname">restart</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code>
if any timeout occurs during the execution of the restart
operation.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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></td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any other error occurs during the execution of the operation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.start">
<code class="descname">start</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code>
if any timeout occurs during the execution of the start operation.
Timeout occurs when the service takes longer than StartTimeout to
start.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any other error occurs during the execution of the operation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.stop">
<code class="descname">stop</code><span class="sig-paren">(</span><em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any other error occurs during the execution of the operation.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.vmon_client.Service.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>service</em>, <em>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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><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>.</li>
<li><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.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
if any other error occurs during the execution of the operation.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
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>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.vmon_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.appliance.vmon_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
</dd></dl>
</div>
</div>
</div>
<div class="articleComments">
</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" 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 2018, VMware, Inc..
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.7.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
View Git Blame Copy Permalink