mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
2989 lines
201 KiB
HTML
2989 lines
201 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>com.vmware.appliance package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: './',
|
|
VERSION: '6.6.1',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</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>
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 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" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="com.vmware.appliance.networking.html" title="com.vmware.appliance.networking package"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="com.vmware.html" title="com.vmware package"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
|
<li><a href="com.html" >com package</a> »</li>
|
|
<li><a href="com.vmware.html" accesskey="U">com.vmware package</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="com-vmware-appliance-package">
|
|
<h1>com.vmware.appliance package<a class="headerlink" href="#com-vmware-appliance-package" 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">Module contents</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#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.restore_client">com.vmware.appliance.recovery.restore_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.techpreview.html">com.vmware.appliance.techpreview package</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#subpackages">Subpackages</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html">com.vmware.appliance.techpreview.networking package</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#subpackages">Subpackages</a><ul>
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html">com.vmware.appliance.techpreview.networking.firewall package</a><ul>
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#module-com.vmware.appliance.techpreview.networking.firewall.addr_client">com.vmware.appliance.techpreview.networking.firewall.addr_client module</a></li>
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#module-com.vmware.appliance.techpreview.networking.firewall">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#module-com.vmware.appliance.techpreview.networking">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.localaccounts_client">com.vmware.appliance.techpreview.localaccounts_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.monitoring_client">com.vmware.appliance.techpreview.monitoring_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.networking_client">com.vmware.appliance.techpreview.networking_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.ntp_client">com.vmware.appliance.techpreview.ntp_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.services_client">com.vmware.appliance.techpreview.services_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.system_client">com.vmware.appliance.techpreview.system_client module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview">Module contents</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>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.access_client.Consolecli">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.access_client.</tt><tt class="descname">Consolecli</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.access_client.Consolecli" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Consolecli</span></tt> class provides methods Get/Set enabled state of 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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Consolecli.get">
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Consolecli.set">
|
|
<tt class="descname">set</tt><big>(</big><em>enabled</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Console-based controlled CLI is enabled.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.access_client.</tt><tt class="descname">Dcui</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.access_client.Dcui" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Dcui</span></tt> class provides methods Get/Set enabled state of DCUI.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Dcui.get">
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Dcui.set">
|
|
<tt class="descname">set</tt><big>(</big><em>enabled</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – DCUI is enabled.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.access_client.</tt><tt class="descname">Shell</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.access_client.Shell" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Shell</span></tt> class provides methods Get/Set enabled state of BASH.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.access_client.Shell.ShellConfig">
|
|
<em class="property">class </em><tt class="descname">ShellConfig</tt><big>(</big><em>enabled=None</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.access_client.Shell.ShellConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Shell.ShellConfig</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Enabled can be set to true or false</li>
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The timeout (in seconds) specifies how long you enable the Shell
|
|
access. The maximum timeout is 86400 seconds(1 day).</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Shell.get">
|
|
<tt class="descclassname">Shell.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Shell.ShellConfig</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Shell.set">
|
|
<tt class="descclassname">Shell.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Shell.ShellConfig</span></tt></a>) – Shell configuration</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.access_client.</tt><tt class="descname">Ssh</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.access_client.Ssh" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ssh</span></tt> class provides methods Get/Set enabled state of 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>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Ssh.get">
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.access_client.Ssh.set">
|
|
<tt class="descname">set</tt><big>(</big><em>enabled</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – SSH-based controlled CLI is enabled.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.health_client">
|
|
<span id="com-vmware-appliance-health-client-module"></span><h2>com.vmware.appliance.health_client module<a class="headerlink" href="#module-com.vmware.appliance.health_client" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Applmgmt">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Applmgmt</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Applmgmt" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Applmgmt</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.health_client.Applmgmt.get">
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Databasestorage</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Databasestorage</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Databasestorage.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'green')</em><a class="headerlink" href="#com.vmware.appliance.health_client.Databasestorage.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.Databasestorage.HealthLevel.orange">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Databasestorage.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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 state, but experiencing some levels of problems.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.health_client.Databasestorage.get">
|
|
<tt class="descclassname">Databasestorage.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Databasestorage.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Load</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Load" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Load</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Load.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Load.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Load.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Load.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">Load.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Load.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Mem</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Mem" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Mem</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Mem.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Mem.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Mem.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">Mem.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Mem.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Softwarepackages</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Softwarepackages</span></tt> class provides methods Get information on available
|
|
software updates available in remote VUM repository.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Softwarepackages.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Softwarepackages.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">Softwarepackages.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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 remote VUM
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">Softwarepackages.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Storage</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Storage" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Storage</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Storage.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Storage.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Storage.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">Storage.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Storage.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Swap">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">Swap</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Swap" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Swap</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.Swap.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Swap.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.Swap.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">Swap.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Swap.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.health_client.</tt><tt class="descname">System</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.System" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">System</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.health_client.System.HealthLevel">
|
|
<em class="property">class </em><tt class="descname">HealthLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.health_client.System.HealthLevel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">System.HealthLevel</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HealthLevel</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.System.HealthLevel.gray">
|
|
<tt class="descname">gray</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">green</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">orange</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descname">red</tt><em class="property"> = HealthLevel(string=u'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 and is not functioning properly or will stop
|
|
functioning soon.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.health_client.System.HealthLevel.yellow">
|
|
<tt class="descname">yellow</tt><em class="property"> = HealthLevel(string=u'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">
|
|
<tt class="descclassname">System.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">System.HealthLevel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.health_client.System.lastcheck">
|
|
<tt class="descclassname">System.</tt><tt class="descname">lastcheck</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.networking_client">
|
|
<span id="com-vmware-appliance-networking-client-module"></span><h2>com.vmware.appliance.networking_client module<a class="headerlink" href="#module-com.vmware.appliance.networking_client" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.networking_client.Interfaces">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.networking_client.</tt><tt class="descname">Interfaces</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Interfaces</span></tt> class provides methods Provides information about 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>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo">
|
|
<em class="property">class </em><tt class="descname">InterfaceInfo</tt><big>(</big><em>name=None</em>, <em>status=None</em>, <em>mac=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Interfaces.InterfaceInfo</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Interface name, for example, “nic0”, “nic1”.</li>
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus" title="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus"><tt class="xref py py-class docutils literal"><span class="pre">Interfaces.InterfaceStatus</span></tt></a>) – Interface status.</li>
|
|
<li><strong>mac</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – MAC address. For example 00:0C:29:94:BB:5A.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus">
|
|
<em class="property">class </em><tt class="descclassname">Interfaces.</tt><tt class="descname">InterfaceStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Interfaces.InterfaceStatus</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">InterfaceStatus</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.down">
|
|
<tt class="descname">down</tt><em class="property"> = InterfaceStatus(string=u'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">
|
|
<tt class="descname">up</tt><em class="property"> = InterfaceStatus(string=u'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">
|
|
<tt class="descclassname">Interfaces.</tt><tt class="descname">get</tt><big>(</big><em>interface_name</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Network interface, for example, “nic0”.
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.networking.interfaces</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">Interfaces.InterfaceInfo</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.networking_client.Interfaces.list">
|
|
<tt class="descclassname">Interfaces.</tt><tt class="descname">list</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" title="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"><tt class="xref py py-class docutils literal"><span class="pre">Interfaces.InterfaceInfo</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.recovery_client">
|
|
<span id="com-vmware-appliance-recovery-client-module"></span><h2>com.vmware.appliance.recovery_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery_client" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery_client.</tt><tt class="descname">Backup</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup</span></tt> class provides methods Performs backup restore operations</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.BackupRequest">
|
|
<em class="property">class </em><tt class="descname">BackupRequest</tt><big>(</big><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><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.BackupRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup.BackupRequest</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>parts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – a list of optional parts. Run backup parts APIs to get list of
|
|
optional parts and description</li>
|
|
<li><strong>backup_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – a password for a backup piece The backupPassword must adhere to the
|
|
following password requirements: At least 8 characters, cannot be
|
|
more than 20 characters in length. At least 1 uppercase letter. At
|
|
least 1 lowercase letter. At least 1 numeric digit. At least 1
|
|
special character (i.e. any character not in [0-9,a-z,A-Z]). Only
|
|
visible ASCII characters (for example, no space).
|
|
backupPassword If no password then the piece will not be encrypted</li>
|
|
<li><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.LocationType" title="com.vmware.appliance.recovery_client.Backup.LocationType"><tt class="xref py py-class docutils literal"><span class="pre">Backup.LocationType</span></tt></a>) – a type of location</li>
|
|
<li><strong>location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – path or url</li>
|
|
<li><strong>location_user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – username for location
|
|
locationUser User name for this location if login is required.</li>
|
|
<li><strong>location_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – password for location
|
|
locationPassword Password for the specified user if login is
|
|
required at this location.</li>
|
|
<li><strong>comment</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Custom comment
|
|
comment an optional comment</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.LocalizableMessage">
|
|
<em class="property">class </em><tt class="descclassname">Backup.</tt><tt class="descname">LocalizableMessage</tt><big>(</big><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup.LocalizableMessage</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – id in message bundle</li>
|
|
<li><strong>default_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – text in english</li>
|
|
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – nested data</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType">
|
|
<em class="property">class </em><tt class="descclassname">Backup.</tt><tt class="descname">LocationType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.LocationType" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup.LocationType</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">LocationType</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.LocationType.FTP">
|
|
<tt class="descname">FTP</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">FTPS</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">HTTP</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">HTTPS</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">SCP</tt><em class="property"> = LocationType(string=u'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><tt class="descclassname">Backup.</tt><tt class="descname">ReturnResult</tt><big>(</big><em>status=None</em>, <em>messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnResult" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup.ReturnResult</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus" title="com.vmware.appliance.recovery_client.Backup.ReturnStatus"><tt class="xref py py-class docutils literal"><span class="pre">Backup.ReturnStatus</span></tt></a>) – Check status</li>
|
|
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery_client.Backup.LocalizableMessage" title="com.vmware.appliance.recovery_client.Backup.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Backup.LocalizableMessage</span></tt></a>) – List of messages</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus">
|
|
<em class="property">class </em><tt class="descclassname">Backup.</tt><tt class="descname">ReturnStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Backup.ReturnStatus</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">ReturnStatus</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.recovery_client.Backup.ReturnStatus.FAIL">
|
|
<tt class="descname">FAIL</tt><em class="property"> = ReturnStatus(string=u'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">
|
|
<tt class="descname">OK</tt><em class="property"> = ReturnStatus(string=u'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">
|
|
<tt class="descname">WARNING</tt><em class="property"> = ReturnStatus(string=u'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">
|
|
<tt class="descclassname">Backup.</tt><tt class="descname">validate</tt><big>(</big><em>piece</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Backup.BackupRequest</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">Backup.ReturnResult</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.recovery_client.</tt><tt class="descname">Restore</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Restore</span></tt> class provides methods Performs restore operations</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Restore.LocalizableMessage">
|
|
<em class="property">class </em><tt class="descname">LocalizableMessage</tt><big>(</big><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Restore.LocalizableMessage</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – id in message bundle</li>
|
|
<li><strong>default_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – text in english</li>
|
|
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – nested data</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType">
|
|
<em class="property">class </em><tt class="descclassname">Restore.</tt><tt class="descname">LocationType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.LocationType" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Restore.LocationType</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">LocationType</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.recovery_client.Restore.LocationType.FTP">
|
|
<tt class="descname">FTP</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">FTPS</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">HTTP</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">HTTPS</tt><em class="property"> = LocationType(string=u'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">
|
|
<tt class="descname">SCP</tt><em class="property"> = LocationType(string=u'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><tt class="descclassname">Restore.</tt><tt class="descname">Metadata</tt><big>(</big><em>timestamp=None</em>, <em>parts=None</em>, <em>version=None</em>, <em>boxname=None</em>, <em>comment=None</em>, <em>applicable=None</em>, <em>messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.Metadata" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Restore.Metadata</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>timestamp</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Time when this backup was completed.</li>
|
|
<li><strong>parts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – List of parts included in the backup.</li>
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – VCSA version</li>
|
|
<li><strong>boxname</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Box name is PNID/ FQDN etc</li>
|
|
<li><strong>comment</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Custom comment</li>
|
|
<li><strong>applicable</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Does the VCSA match the deployment type, network properties and
|
|
version of backed up VC</li>
|
|
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.LocalizableMessage" title="com.vmware.appliance.recovery_client.Restore.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Restore.LocalizableMessage</span></tt></a>) – Any messages if the backup is not aplicable</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.recovery_client.Restore.RestoreRequest">
|
|
<em class="property">class </em><tt class="descclassname">Restore.</tt><tt class="descname">RestoreRequest</tt><big>(</big><em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery_client.Restore.RestoreRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Restore.RestoreRequest</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>backup_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – a password for a backup piece
|
|
backupPassword If no password then the piece will not be decrypted</li>
|
|
<li><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery_client.Restore.LocationType" title="com.vmware.appliance.recovery_client.Restore.LocationType"><tt class="xref py py-class docutils literal"><span class="pre">Restore.LocationType</span></tt></a>) – a type of location</li>
|
|
<li><strong>location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – path or url</li>
|
|
<li><strong>location_user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – username for location
|
|
locationUser User name for this location if login is required.</li>
|
|
<li><strong>location_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – password for location
|
|
locationPassword Password for the specified user if login is
|
|
required at this location.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.recovery_client.Restore.validate">
|
|
<tt class="descclassname">Restore.</tt><tt class="descname">validate</tt><big>(</big><em>piece</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Restore.RestoreRequest</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">Restore.Metadata</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.system_client">
|
|
<span id="com-vmware-appliance-system-client-module"></span><h2>com.vmware.appliance.system_client module<a class="headerlink" href="#module-com.vmware.appliance.system_client" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.system_client.Storage">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.system_client.</tt><tt class="descname">Storage</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Storage" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Storage</span></tt> class provides methods Appliance storage configuration</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.system_client.Storage.StorageMapping">
|
|
<em class="property">class </em><tt class="descname">StorageMapping</tt><big>(</big><em>disk=None</em>, <em>partition=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Storage.StorageMapping" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Storage.StorageMapping</span></tt> class FIXME: no docstring</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>
|
|
<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 last simple">
|
|
<li><strong>disk</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – NGC disk ID
|
|
When clients pass a value of this class as a parameter, the
|
|
attribute must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.system.storage</span></tt>. When methods return a
|
|
value of this class as a return value, the attribute will be an
|
|
identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.system.storage</span></tt>.</li>
|
|
<li><strong>partition</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Storage partition name</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.system_client.Storage.list">
|
|
<tt class="descclassname">Storage.</tt><tt class="descname">list</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.system_client.Storage.StorageMapping" title="com.vmware.appliance.system_client.Storage.StorageMapping"><tt class="xref py py-class docutils literal"><span class="pre">Storage.StorageMapping</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.system_client.Storage.resize">
|
|
<tt class="descclassname">Storage.</tt><tt class="descname">resize</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.system_client.Time">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.system_client.</tt><tt class="descname">Time</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Time" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Time</span></tt> class provides methods Gets 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.system_client.Time.SystemTimeStruct">
|
|
<em class="property">class </em><tt class="descname">SystemTimeStruct</tt><big>(</big><em>seconds_since_epoch=None</em>, <em>date=None</em>, <em>time=None</em>, <em>timezone=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Time.SystemTimeStruct" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Time.SystemTimeStruct</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>seconds_since_epoch</strong> (<tt class="xref py py-class docutils literal"><span class="pre">float</span></tt>) – seconds since the epoch</li>
|
|
<li><strong>date</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – date format: Thu 07-31-2014</li>
|
|
<li><strong>time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – time format: 18:18:32</li>
|
|
<li><strong>timezone</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – timezone</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.system_client.Time.get">
|
|
<tt class="descclassname">Time.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Time.SystemTimeStruct</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.system_client.</tt><tt class="descname">Uptime</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Uptime" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Uptime</span></tt> class provides methods 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.system_client.Uptime.get">
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">float</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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><tt class="descclassname">com.vmware.appliance.system_client.</tt><tt class="descname">Version</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Version</span></tt> class provides methods Get the appliance 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.system_client.Version.VersionStruct">
|
|
<em class="property">class </em><tt class="descname">VersionStruct</tt><big>(</big><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><big>)</big><a class="headerlink" href="#com.vmware.appliance.system_client.Version.VersionStruct" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Version.VersionStruct</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Appliance version.</li>
|
|
<li><strong>product</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Appliance name.</li>
|
|
<li><strong>build</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Appliance build number.</li>
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type of product. Same product can have different deployment
|
|
options, which is represented by type.</li>
|
|
<li><strong>summary</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Summary of patch (empty string, if the appliance has not been
|
|
patched)</li>
|
|
<li><strong>releasedate</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Release date of patch (empty string, if the appliance has not been
|
|
patched)</li>
|
|
<li><strong>install_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Display the date and time when this system was first installed.
|
|
Value will not change on subsequent updates.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.system_client.Version.get">
|
|
<tt class="descclassname">Version.</tt><tt class="descname">get</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">Version.VersionStruct</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.techpreview_client">
|
|
<span id="com-vmware-appliance-techpreview-client-module"></span><h2>com.vmware.appliance.techpreview_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview_client" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview_client.</tt><tt class="descname">Ntp</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp</span></tt> class provides methods Gets NTP configuration status and tests
|
|
connection to ntp servers.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.Message">
|
|
<em class="property">class </em><tt class="descname">Message</tt><big>(</big><em>message=None</em>, <em>result=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.Message" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.Message</span></tt> class Test result and 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>
|
|
<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 last simple">
|
|
<li><strong>message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – message</li>
|
|
<li><strong>result</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview_client.Ntp.MessageStatus" title="com.vmware.appliance.techpreview_client.Ntp.MessageStatus"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.MessageStatus</span></tt></a>) – result of the test</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.MessageStatus">
|
|
<em class="property">class </em><tt class="descclassname">Ntp.</tt><tt class="descname">MessageStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.MessageStatus" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.MessageStatus</span></tt> class Individual test result</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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">MessageStatus</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.MessageStatus.failure">
|
|
<tt class="descname">failure</tt><em class="property"> = MessageStatus(string=u'failure')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.MessageStatus.failure" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>message indicates the test failed.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.MessageStatus.success">
|
|
<tt class="descname">success</tt><em class="property"> = MessageStatus(string=u'success')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.MessageStatus.success" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>message indicates that the test was successful.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.NTPConfig">
|
|
<em class="property">class </em><tt class="descclassname">Ntp.</tt><tt class="descname">NTPConfig</tt><big>(</big><em>status=None</em>, <em>servers=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.NTPConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.NTPConfig</span></tt> class Structure defining the NTP 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>
|
|
<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 last simple">
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview_client.Ntp.NTPStatus" title="com.vmware.appliance.techpreview_client.Ntp.NTPStatus"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.NTPStatus</span></tt></a>) – NTP daemon running status</li>
|
|
<li><strong>servers</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – List of NTP servers.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.NTPStatus">
|
|
<em class="property">class </em><tt class="descclassname">Ntp.</tt><tt class="descname">NTPStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.NTPStatus" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.NTPStatus</span></tt> class Defines NTP 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">NTPStatus</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Down">
|
|
<tt class="descname">Down</tt><em class="property"> = NTPStatus(string=u'Down')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Down" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>NTP daemon is not running.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Unknown">
|
|
<tt class="descname">Unknown</tt><em class="property"> = NTPStatus(string=u'Unknown')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Unknown" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Cannot retrieve NTP daemon status.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Up">
|
|
<tt class="descname">Up</tt><em class="property"> = NTPStatus(string=u'Up')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.NTPStatus.Up" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>NTP daemon is running.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.TestStatus">
|
|
<em class="property">class </em><tt class="descclassname">Ntp.</tt><tt class="descname">TestStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatus" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.TestStatus</span></tt> class Health indicator</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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">TestStatus</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.TestStatus.green">
|
|
<tt class="descname">green</tt><em class="property"> = TestStatus(string=u'green')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatus.green" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>All tests were successful for given data</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.TestStatus.orange">
|
|
<tt class="descname">orange</tt><em class="property"> = TestStatus(string=u'orange')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatus.orange" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>In case data has more than one test, this indicates not all tests were
|
|
successful</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.TestStatus.red">
|
|
<tt class="descname">red</tt><em class="property"> = TestStatus(string=u'red')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatus.red" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>All tests failed for given data</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.TestStatusInfo">
|
|
<em class="property">class </em><tt class="descclassname">Ntp.</tt><tt class="descname">TestStatusInfo</tt><big>(</big><em>status=None</em>, <em>messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatusInfo" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Ntp.TestStatusInfo</span></tt> class Overall test 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>
|
|
<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 last simple">
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview_client.Ntp.TestStatus" title="com.vmware.appliance.techpreview_client.Ntp.TestStatus"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.TestStatus</span></tt></a>) – Overall status of tests run.</li>
|
|
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.techpreview_client.Ntp.Message" title="com.vmware.appliance.techpreview_client.Ntp.Message"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.Message</span></tt></a>) – messages</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.get">
|
|
<tt class="descclassname">Ntp.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.get" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Get the NTP configuration status. If you run the ‘timesync.get’
|
|
command, you can retrieve the current time synchronization method (NTP-
|
|
or VMware Tools-based). The ‘ntp’ command always returns the NTP server
|
|
information, even when the time synchronization mode is not set to NTP.
|
|
If the time synchronization mode is not NTP-based, the NTP server
|
|
status is displayed as down.</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.techpreview_client.Ntp.NTPConfig" title="com.vmware.appliance.techpreview_client.Ntp.NTPConfig"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.NTPConfig</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">NTP config</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Ntp.test">
|
|
<tt class="descclassname">Ntp.</tt><tt class="descname">test</tt><big>(</big><em>servers</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Ntp.test" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Test the connection to a list of ntp servers.</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> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – List of host names or IP addresses of NTP servers.</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.techpreview_client.Ntp.TestStatusInfo" title="com.vmware.appliance.techpreview_client.Ntp.TestStatusInfo"><tt class="xref py py-class docutils literal"><span class="pre">Ntp.TestStatusInfo</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">NTP connection status</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview_client.</tt><tt class="descname">Services</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Services</span></tt> class provides methods Manages 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceInfo">
|
|
<em class="property">class </em><tt class="descname">ServiceInfo</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>operations=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceInfo" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Services.ServiceInfo</span></tt> class Structure that describes a service and the
|
|
operations you can perform on 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>
|
|
<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 last simple">
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the service, for example, “vmware-vpxd”. This name is
|
|
unique per machine.</li>
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A description of the service. The description can be empty.</li>
|
|
<li><strong>operations</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps" title="com.vmware.appliance.techpreview_client.Services.ServiceOps"><tt class="xref py py-class docutils literal"><span class="pre">Services.ServiceOps</span></tt></a>) – The operations encoded in an array, supported by the service.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceOps">
|
|
<em class="property">class </em><tt class="descclassname">Services.</tt><tt class="descname">ServiceOps</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Services.ServiceOps</span></tt> class Defines service operations</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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">ServiceOps</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceOps.control">
|
|
<tt class="descname">control</tt><em class="property"> = ServiceOps(string=u'control')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps.control" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The service accepts arbitrary commands and arguments.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceOps.restart">
|
|
<tt class="descname">restart</tt><em class="property"> = ServiceOps(string=u'restart')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps.restart" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The service can be started or restarted.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceOps.status">
|
|
<tt class="descname">status</tt><em class="property"> = ServiceOps(string=u'status')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps.status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The service status can be generated.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.ServiceOps.stop">
|
|
<tt class="descname">stop</tt><em class="property"> = ServiceOps(string=u'stop')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.ServiceOps.stop" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The service can be stopped.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.control">
|
|
<tt class="descclassname">Services.</tt><tt class="descname">control</tt><big>(</big><em>args</em>, <em>name</em>, <em>timeout</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.control" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Manage a service with arbitrary command and arguments.</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>args</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview_client.Services.list" title="com.vmware.appliance.techpreview_client.Services.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Array of arguments.</li>
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the service.</li>
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Timeout in seconds. Zero (0) means no timeout.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.list">
|
|
<tt class="descclassname">Services.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.list" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Get a list of all known 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"><a class="reference internal" href="#com.vmware.appliance.techpreview_client.Services.list" title="com.vmware.appliance.techpreview_client.Services.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.techpreview_client.Services.ServiceInfo" title="com.vmware.appliance.techpreview_client.Services.ServiceInfo"><tt class="xref py py-class docutils literal"><span class="pre">Services.ServiceInfo</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of services.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.restart">
|
|
<tt class="descclassname">Services.</tt><tt class="descname">restart</tt><big>(</big><em>name</em>, <em>timeout</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.restart" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>start or restart 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the service to start or restart.</li>
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Timeout in seconds. Zero (0) means no timeout.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Services.stop">
|
|
<tt class="descclassname">Services.</tt><tt class="descname">stop</tt><big>(</big><em>name</em>, <em>timeout</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Services.stop" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Stop 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of service.</li>
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Timeout in seconds. Zero (0) means no timeout.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview_client.</tt><tt class="descname">Shutdown</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Shutdown</span></tt> class provides methods Performs reboot/shutdow operations on
|
|
appliance.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.ShutdownConfig">
|
|
<em class="property">class </em><tt class="descname">ShutdownConfig</tt><big>(</big><em>delay=None</em>, <em>reason=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.ShutdownConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Shutdown.ShutdownConfig</span></tt> class Structure that defines shutdown
|
|
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>
|
|
<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 last simple">
|
|
<li><strong>delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Delay interval in minutes (optional). if you do not specify delay,
|
|
then the shutdown starts immediately.</li>
|
|
<li><strong>reason</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Reason for performing shutdown (required).</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.ShutdownGetConfig">
|
|
<em class="property">class </em><tt class="descclassname">Shutdown.</tt><tt class="descname">ShutdownGetConfig</tt><big>(</big><em>shutdown_time=None</em>, <em>action=None</em>, <em>reason=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.ShutdownGetConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Shutdown.ShutdownGetConfig</span></tt> class Structure that defines shutdown
|
|
configuration returned by Shutdown.get operation</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>
|
|
<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 last simple">
|
|
<li><strong>shutdown_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – (UTC) time of shutdown represented in “YYYY-MM-DD HH:MM:SS” format.</li>
|
|
<li><strong>action</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Contains a string that describes the pending shutdown operation.
|
|
The string values for pending operations can be ‘poweroff’,
|
|
‘reboot’ or ‘’</li>
|
|
<li><strong>reason</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – This will contain string explaining the reason behind the shutdown
|
|
action</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.cancel">
|
|
<tt class="descclassname">Shutdown.</tt><tt class="descname">cancel</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.cancel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Cancel pending shutdown action.</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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.get">
|
|
<tt class="descclassname">Shutdown.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.get" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Get details about the pending shutdown action.</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.techpreview_client.Shutdown.ShutdownGetConfig" title="com.vmware.appliance.techpreview_client.Shutdown.ShutdownGetConfig"><tt class="xref py py-class docutils literal"><span class="pre">Shutdown.ShutdownGetConfig</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Configuration of pending shutdown action.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.poweroff">
|
|
<tt class="descclassname">Shutdown.</tt><tt class="descname">poweroff</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.poweroff" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Power off the appliance.</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.techpreview_client.Shutdown.ShutdownConfig" title="com.vmware.appliance.techpreview_client.Shutdown.ShutdownConfig"><tt class="xref py py-class docutils literal"><span class="pre">Shutdown.ShutdownConfig</span></tt></a>) – Configuration of poweroff action</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Shutdown.reboot">
|
|
<tt class="descclassname">Shutdown.</tt><tt class="descname">reboot</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Shutdown.reboot" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Reboot the appliance.</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.techpreview_client.Shutdown.ShutdownConfig" title="com.vmware.appliance.techpreview_client.Shutdown.ShutdownConfig"><tt class="xref py py-class docutils literal"><span class="pre">Shutdown.ShutdownConfig</span></tt></a>) – Configuration of reboot action</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync">
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview_client.</tt><tt class="descname">Timesync</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Timesync</span></tt> class provides methods Performs time synchronization
|
|
configuration.</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> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.TimeSyncConfig">
|
|
<em class="property">class </em><tt class="descname">TimeSyncConfig</tt><big>(</big><em>mode=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Timesync.TimeSyncConfig</span></tt> class Structure defining time synchronization
|
|
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>
|
|
<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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode" title="com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode"><tt class="xref py py-class docutils literal"><span class="pre">Timesync.TimeSyncMode</span></tt></a>) – Time synchronization mode. Mode can have one of the TimeSyncMode
|
|
enumeration values.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode">
|
|
<em class="property">class </em><tt class="descclassname">Timesync.</tt><tt class="descname">TimeSyncMode</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p><tt class="docutils literal"><span class="pre">Timesync.TimeSyncMode</span></tt> class Defines different timsync modes</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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">TimeSyncMode</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.Disabled">
|
|
<tt class="descname">Disabled</tt><em class="property"> = TimeSyncMode(string=u'Disabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.Disabled" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Time synchronization is disabled.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.NTP">
|
|
<tt class="descname">NTP</tt><em class="property"> = TimeSyncMode(string=u'NTP')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.NTP" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>NTP-based time synchronization.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.host">
|
|
<tt class="descname">host</tt><em class="property"> = TimeSyncMode(string=u'host')</em><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.TimeSyncMode.host" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>VMware Tool-based time synchronization.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.get">
|
|
<tt class="descclassname">Timesync.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.get" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Get time synchronization configuration.</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.techpreview_client.Timesync.TimeSyncConfig" title="com.vmware.appliance.techpreview_client.Timesync.TimeSyncConfig"><tt class="xref py py-class docutils literal"><span class="pre">Timesync.TimeSyncConfig</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time synchronization configuration.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.techpreview_client.Timesync.set">
|
|
<tt class="descclassname">Timesync.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview_client.Timesync.set" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Set time synchronization configuration.</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.techpreview_client.Timesync.TimeSyncConfig" title="com.vmware.appliance.techpreview_client.Timesync.TimeSyncConfig"><tt class="xref py py-class docutils literal"><span class="pre">Timesync.TimeSyncConfig</span></tt></a>) – Time synchronization configuration.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
Generic error</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance.vmon_client">
|
|
<span id="com-vmware-appliance-vmon-client-module"></span><h2>com.vmware.appliance.vmon_client module<a class="headerlink" href="#module-com.vmware.appliance.vmon_client" title="Permalink to this headline">¶</a></h2>
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon_client</span></tt> 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><tt class="descclassname">com.vmware.appliance.vmon_client.</tt><tt class="descname">Service</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service</span></tt> class provides methods to manage a single/set of services
|
|
that are 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">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.Health">
|
|
<em class="property">class </em><tt class="descname">Health</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Health" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service.Health</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Health</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.Health.DEGRADED">
|
|
<tt class="descname">DEGRADED</tt><em class="property"> = Health(string=u'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">
|
|
<tt class="descname">HEALTHY</tt><em class="property"> = Health(string=u'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">
|
|
<tt class="descname">HEALTHY_WITH_WARNINGS</tt><em class="property"> = Health(string=u'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><tt class="descclassname">Service.</tt><tt class="descname">Info</tt><big>(</big><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><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.Info" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service.Info</span></tt> 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>
|
|
<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 last simple">
|
|
<li><strong>name_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Service name key. Can be used to lookup resource bundle</li>
|
|
<li><strong>description_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Service description key. Can be used to lookup resource bundle</li>
|
|
<li><strong>startup_type</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType" title="com.vmware.appliance.vmon_client.Service.StartupType"><tt class="xref py py-class docutils literal"><span class="pre">Service.StartupType</span></tt></a>) – Startup Type.</li>
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State" title="com.vmware.appliance.vmon_client.Service.State"><tt class="xref py py-class docutils literal"><span class="pre">Service.State</span></tt></a>) – Running State.</li>
|
|
<li><strong>health</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.Health" title="com.vmware.appliance.vmon_client.Service.Health"><tt class="xref py py-class docutils literal"><span class="pre">Service.Health</span></tt></a>) – Health of service.
|
|
This attribute is optional and it is only relevant when the value
|
|
of <tt class="docutils literal"><span class="pre">state</span></tt> is <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State.STARTED" title="com.vmware.appliance.vmon_client.Service.State.STARTED"><tt class="xref py py-attr docutils literal"><span class="pre">Service.State.STARTED</span></tt></a>.</li>
|
|
<li><strong>health_messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – Localizable messages associated with the health of the service
|
|
This attribute is optional and it is only relevant when the value
|
|
of <tt class="docutils literal"><span class="pre">state</span></tt> is <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.State.STARTED" title="com.vmware.appliance.vmon_client.Service.State.STARTED"><tt class="xref py py-attr docutils literal"><span class="pre">Service.State.STARTED</span></tt></a>.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.StartupType">
|
|
<em class="property">class </em><tt class="descclassname">Service.</tt><tt class="descname">StartupType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.StartupType" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service.StartupType</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">StartupType</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.StartupType.AUTOMATIC">
|
|
<tt class="descname">AUTOMATIC</tt><em class="property"> = StartupType(string=u'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">
|
|
<tt class="descname">DISABLED</tt><em class="property"> = StartupType(string=u'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">
|
|
<tt class="descname">MANUAL</tt><em class="property"> = StartupType(string=u'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><tt class="descclassname">Service.</tt><tt class="descname">State</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.State" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service.State</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
|
type description page</em></a>.</p>
|
|
</div>
|
|
<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>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">State</span></tt> instance.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.State.STARTED">
|
|
<tt class="descname">STARTED</tt><em class="property"> = State(string=u'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">
|
|
<tt class="descname">STARTING</tt><em class="property"> = State(string=u'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">
|
|
<tt class="descname">STOPPED</tt><em class="property"> = State(string=u'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">
|
|
<tt class="descname">STOPPING</tt><em class="property"> = State(string=u'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><tt class="descclassname">Service.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>startup_type=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.vmon_client.Service.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">Service.UpdateSpec</span></tt> 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>
|
|
<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>startup_type</strong> (<a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType" title="com.vmware.appliance.vmon_client.Service.StartupType"><tt class="xref py py-class docutils literal"><span class="pre">Service.StartupType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Startup Type
|
|
If unspecified, leaves value unchanged.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="com.vmware.appliance.vmon_client.Service.get">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">get</tt><big>(</big><em>service</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – identifier of the service whose state is being queried.
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">Service.Info</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
|
if the service associated with <tt class="docutils literal"><span class="pre">service</span></tt> does not exist.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">list_details</tt><big>(</big><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.Info" title="com.vmware.appliance.vmon_client.Service.Info"><tt class="xref py py-class docutils literal"><span class="pre">Service.Info</span></tt></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 <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> will be an identifier for
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">restart</tt><big>(</big><em>service</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – identifier of the service to restart
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
|
if the service associated with <tt class="docutils literal"><span class="pre">service</span></tt> does not exist.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">Service.StartupType.DISABLED</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">start</tt><big>(</big><em>service</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – identifier of the service to start
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
|
if the service associated with <tt class="docutils literal"><span class="pre">service</span></tt> does not exist.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">Service.StartupType.DISABLED</span></tt></a>.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">stop</tt><big>(</big><em>service</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – identifier of the service to stop
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
|
if the service associated with <tt class="docutils literal"><span class="pre">service</span></tt> does not exist.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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">
|
|
<tt class="descclassname">Service.</tt><tt class="descname">update</tt><big>(</big><em>service</em>, <em>spec</em><big>)</big><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – identifier of the service whose properties are being updated.
|
|
The parameter must be an identifier for the resource type:
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.vmon.Service</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">Service.UpdateSpec</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
|
if the service associated with <tt class="docutils literal"><span class="pre">service</span></tt> does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
|
if a request to set the <tt class="xref py py-attr docutils literal"><span class="pre">Service.UpdateSpec.startup_type</span></tt>
|
|
attribute of <tt class="docutils literal"><span class="pre">spec</span></tt> to <a class="reference internal" href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED" title="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"><tt class="xref py py-attr docutils literal"><span class="pre">Service.StartupType.DISABLED</span></tt></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"><tt class="xref py py-attr docutils literal"><span class="pre">Service.State.STOPPED</span></tt></a>
|
|
state.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-com.vmware.appliance">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.appliance" title="Permalink to this headline">¶</a></h2>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">com.vmware.appliance package</a><ul>
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.access_client">com.vmware.appliance.access_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.health_client">com.vmware.appliance.health_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.networking_client">com.vmware.appliance.networking_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery_client">com.vmware.appliance.recovery_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.system_client">com.vmware.appliance.system_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview_client">com.vmware.appliance.techpreview_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.vmon_client">com.vmware.appliance.vmon_client module</a></li>
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="com.vmware.html"
|
|
title="previous chapter">com.vmware package</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="com.vmware.appliance.networking.html"
|
|
title="next chapter">com.vmware.appliance.networking package</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/com.vmware.appliance.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="com.vmware.appliance.networking.html" title="com.vmware.appliance.networking package"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="com.vmware.html" title="com.vmware package"
|
|
>previous</a> |</li>
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
|
<li><a href="com.html" >com package</a> »</li>
|
|
<li><a href="com.vmware.html" >com.vmware package</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
|
</div>
|
|
</body>
|
|
</html> |