mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-23 01:49:59 -05:00
2846 lines
211 KiB
HTML
2846 lines
211 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.techpreview 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.appliance package" href="com.vmware.appliance.html" />
|
||
|
|
<link rel="next" title="com.vmware.appliance.techpreview.networking package" href="com.vmware.appliance.techpreview.networking.html" />
|
||
|
|
<link rel="prev" title="com.vmware.appliance.recovery package" href="com.vmware.appliance.recovery.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.techpreview.networking.html" title="com.vmware.appliance.techpreview.networking package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.recovery.html" title="com.vmware.appliance.recovery 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" >com.vmware package</a> »</li>
|
||
|
|
<li><a href="com.vmware.appliance.html" accesskey="U">com.vmware.appliance package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-appliance-techpreview-package">
|
||
|
|
<h1>com.vmware.appliance.techpreview package<a class="headerlink" href="#com-vmware-appliance-techpreview-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.techpreview.networking.html">com.vmware.appliance.techpreview.networking package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html">com.vmware.appliance.techpreview.networking.firewall package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><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-l4"><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-l2"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#module-com.vmware.appliance.techpreview.networking">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.techpreview.localaccounts_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-localaccounts-client-module"></span><h2>com.vmware.appliance.techpreview.localaccounts_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.localaccounts_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.localaccounts_client.</tt><tt class="descname">User</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User" 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">User</span></tt> class provides methods Perform operations on local user account.</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.localaccounts_client.User.NewUserConfig">
|
||
|
|
<em class="property">class </em><tt class="descname">NewUserConfig</tt><big>(</big><em>username=None</em>, <em>role=None</em>, <em>password=None</em>, <em>fullname=None</em>, <em>email=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.NewUserConfig" 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">User.NewUserConfig</span></tt> class Structure that defines a new user
|
||
|
|
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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login name</li>
|
||
|
|
<li><strong>role</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole"><tt class="xref py py-class docutils literal"><span class="pre">User.UserRole</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – User roles. The default role is operator.
|
||
|
|
role Default role is operator</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login password In Interactive mode, provide –password as part
|
||
|
|
of the command, and enter the value on the prompt. When accessed
|
||
|
|
remotely, provide –password value as part the command.</li>
|
||
|
|
<li><strong>fullname</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>) – User full name
|
||
|
|
fullname Optional full name for a person</li>
|
||
|
|
<li><strong>email</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>) – Email address of the local account.
|
||
|
|
email Optional email</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">User.</tt><tt class="descname">UserAccountStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus" 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">User.UserAccountStatus</span></tt> class Defines status of user accounts</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">UserAccountStatus</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus.disabled">
|
||
|
|
<tt class="descname">disabled</tt><em class="property"> = UserAccountStatus(string=u'disabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus.disabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The user account is disabled.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus.enabled">
|
||
|
|
<tt class="descname">enabled</tt><em class="property"> = UserAccountStatus(string=u'enabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus.enabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The user account is enabled.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserConfig">
|
||
|
|
<em class="property">class </em><tt class="descclassname">User.</tt><tt class="descname">UserConfig</tt><big>(</big><em>username=None</em>, <em>role=None</em>, <em>fullname=None</em>, <em>status=None</em>, <em>email=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserConfig" 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">User.UserConfig</span></tt> class Structure that defines a new user configuration
|
||
|
|
for CLI.</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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login name</li>
|
||
|
|
<li><strong>role</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole"><tt class="xref py py-class docutils literal"><span class="pre">User.UserRole</span></tt></a>) – User roles</li>
|
||
|
|
<li><strong>fullname</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User full name</li>
|
||
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus"><tt class="xref py py-class docutils literal"><span class="pre">User.UserAccountStatus</span></tt></a>) – Enabled status of the local account</li>
|
||
|
|
<li><strong>email</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – email of the local account</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserConfigGet">
|
||
|
|
<em class="property">class </em><tt class="descclassname">User.</tt><tt class="descname">UserConfigGet</tt><big>(</big><em>username=None</em>, <em>role=None</em>, <em>fullname=None</em>, <em>status=None</em>, <em>passwordstatus=None</em>, <em>email=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserConfigGet" 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">User.UserConfigGet</span></tt> class Structure defines a user configuration for
|
||
|
|
user.get API.</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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login name</li>
|
||
|
|
<li><strong>role</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole"><tt class="xref py py-class docutils literal"><span class="pre">User.UserRole</span></tt></a>) – User roles</li>
|
||
|
|
<li><strong>fullname</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User full name</li>
|
||
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserAccountStatus"><tt class="xref py py-class docutils literal"><span class="pre">User.UserAccountStatus</span></tt></a>) – Shows whether the user account is enabled or disabled.</li>
|
||
|
|
<li><strong>passwordstatus</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus"><tt class="xref py py-class docutils literal"><span class="pre">User.UserPasswordStatus</span></tt></a>) – Shows whether the user account is still valid or expired.</li>
|
||
|
|
<li><strong>email</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Email address of the local account.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">User.</tt><tt class="descname">UserPasswordStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus" 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">User.UserPasswordStatus</span></tt> class Defines state of user password</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">UserPasswordStatus</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.expired">
|
||
|
|
<tt class="descname">expired</tt><em class="property"> = UserPasswordStatus(string=u'expired')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.expired" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The password has expired.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.notset">
|
||
|
|
<tt class="descname">notset</tt><em class="property"> = UserPasswordStatus(string=u'notset')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.notset" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>No password has been set</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.valid">
|
||
|
|
<tt class="descname">valid</tt><em class="property"> = UserPasswordStatus(string=u'valid')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserPasswordStatus.valid" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The password is still valid.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole">
|
||
|
|
<em class="property">class </em><tt class="descclassname">User.</tt><tt class="descname">UserRole</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole" 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">User.UserRole</span></tt> class Defines user roles for appliance</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">UserRole</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.admin">
|
||
|
|
<tt class="descname">admin</tt><em class="property"> = UserRole(string=u'admin')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.admin" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Able to configure the appliance.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.operator">
|
||
|
|
<tt class="descname">operator</tt><em class="property"> = UserRole(string=u'operator')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.operator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Able to read the appliance configuration.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.superAdmin">
|
||
|
|
<tt class="descname">superAdmin</tt><em class="property"> = UserRole(string=u'superAdmin')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.UserRole.superAdmin" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Able to configure the appliance, manage local accounts and use the BASH
|
||
|
|
shell</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.add">
|
||
|
|
<tt class="descclassname">User.</tt><tt class="descname">add</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.add" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a new local user account.</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.localaccounts_client.User.NewUserConfig" title="com.vmware.appliance.techpreview.localaccounts_client.User.NewUserConfig"><tt class="xref py py-class docutils literal"><span class="pre">User.NewUserConfig</span></tt></a>) – User 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>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.localaccounts_client.User.delete">
|
||
|
|
<tt class="descclassname">User.</tt><tt class="descname">delete</tt><big>(</big><em>username</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Delete a local user account.</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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login name.</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.localaccounts_client.User.get">
|
||
|
|
<tt class="descclassname">User.</tt><tt class="descname">get</tt><big>(</big><em>username</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get the local user account information.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – User login name.</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.localaccounts_client.User.UserConfigGet" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserConfigGet"><tt class="xref py py-class docutils literal"><span class="pre">User.UserConfigGet</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">local user account 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.techpreview.localaccounts_client.User.list">
|
||
|
|
<tt class="descclassname">User.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>List of local accounts</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.localaccounts_client.User.list" title="com.vmware.appliance.techpreview.localaccounts_client.User.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.localaccounts_client.User.UserConfigGet" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserConfigGet"><tt class="xref py py-class docutils literal"><span class="pre">User.UserConfigGet</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">User 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.localaccounts_client.User.set">
|
||
|
|
<tt class="descclassname">User.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.localaccounts_client.User.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Update local user account properties role, full name, enabled status
|
||
|
|
and password</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.localaccounts_client.User.UserConfig" title="com.vmware.appliance.techpreview.localaccounts_client.User.UserConfig"><tt class="xref py py-class docutils literal"><span class="pre">User.UserConfig</span></tt></a>) – User 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.techpreview.monitoring_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-monitoring-client-module"></span><h2>com.vmware.appliance.techpreview.monitoring_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.monitoring_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.monitoring_client.</tt><tt class="descname">Snmp</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp" 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">Snmp</span></tt> class provides methods SNMP agent 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.techpreview.monitoring_client.Snmp.SNMPAuthProto">
|
||
|
|
<em class="property">class </em><tt class="descname">SNMPAuthProto</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto" 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">Snmp.SNMPAuthProto</span></tt> class Defines SNMP authentication protocols</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">SNMPAuthProto</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.MD5">
|
||
|
|
<tt class="descname">MD5</tt><em class="property"> = SNMPAuthProto(string=u'MD5')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.MD5" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>MD5</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.SHA1">
|
||
|
|
<tt class="descname">SHA1</tt><em class="property"> = SNMPAuthProto(string=u'SHA1')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.SHA1" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>SHA1</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.none">
|
||
|
|
<tt class="descname">none</tt><em class="property"> = SNMPAuthProto(string=u'none')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto.none" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>NONE</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfig">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPConfig</tt><big>(</big><em>authentication=None</em>, <em>communities=None</em>, <em>engineid=None</em>, <em>loglevel=None</em>, <em>notraps=None</em>, <em>port=None</em>, <em>privacy=None</em>, <em>remoteusers=None</em>, <em>syscontact=None</em>, <em>syslocation=None</em>, <em>targets=None</em>, <em>users=None</em>, <em>v3targets=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfig" 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">Snmp.SNMPConfig</span></tt> class Structure that defines the SNMP configuration,
|
||
|
|
provided as input to set(), and never the result of get(). See
|
||
|
|
SNMPConfigReadOnly. This structure is used to configure SNMP v1, v2c, and
|
||
|
|
v3.</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>authentication</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPAuthProto</span></tt></a>) – Set the default authentication protocol. Values can be none, MD5,
|
||
|
|
or SHA1.</li>
|
||
|
|
<li><strong>communities</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>) – Set up to ten communities, each of no more than 64 characters long.
|
||
|
|
The format is: community1[,community2,...]. This setting overwrites
|
||
|
|
any previous settings.</li>
|
||
|
|
<li><strong>engineid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Set SNMPv3 engine ID. The engine ID must contain 5 to 32
|
||
|
|
hexadecimal characters. “0x” and colon (:) are removed from the ID.</li>
|
||
|
|
<li><strong>loglevel</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System Agent syslog logging level: debug|info|warning|error.</li>
|
||
|
|
<li><strong>notraps</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>) – Comma-separated list of trap OIDs (object identifiers) for traps
|
||
|
|
not to be sent by the agent. Use ‘reset’ to clear the setting.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up a UDP port which the SNMP agent uses to listen on for
|
||
|
|
polling requests. The default UDP port is 161.</li>
|
||
|
|
<li><strong>privacy</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPPrivProto</span></tt></a>) – Set the default privacy protocol. Values: none or AES128.</li>
|
||
|
|
<li><strong>remoteusers</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>) – Set up to five inform user IDs. The format is:
|
||
|
|
user/auth-proto/-<a href="#id1"><span class="problematic" id="id2">|</span></a>auth-hash/priv-proto/-<a href="#id3"><span class="problematic" id="id4">|</span></a>priv-hash/engine-id[,...].
|
||
|
|
Here, user must be maximum 32 characters long; auth-proto is none,
|
||
|
|
MD5 or SHA1; priv-proto is none or AES; ‘-‘ indicates no hash;
|
||
|
|
engine-id is a hexadecimal string ‘0x0-9a-f’ and must be up to 32
|
||
|
|
characters long.</li>
|
||
|
|
<li><strong>syscontact</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System contact string as presented in sysContact.0. Up to 255
|
||
|
|
characters long.</li>
|
||
|
|
<li><strong>syslocation</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System location string as presented in sysLocation.0. Up to 255
|
||
|
|
characters long.</li>
|
||
|
|
<li><strong>targets</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>) – Set up to three targets to which to send SNMPv1 traps. The format
|
||
|
|
is: ip-or-hostname[\@port]/community[,...]. The default port is
|
||
|
|
UDP 162. This setting overwrites any previous settings.</li>
|
||
|
|
<li><strong>users</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>) – Set up to five local users. The format is:
|
||
|
|
user/-<a href="#id5"><span class="problematic" id="id6">|</span></a>auth-hash/-<a href="#id7"><span class="problematic" id="id8">|</span></a>priv-hash/model[,...]. Here user is maximum 32
|
||
|
|
characters long; ‘-‘ indicates no hash; model is one of none, auth
|
||
|
|
or priv.</li>
|
||
|
|
<li><strong>v3targets</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>) – Set up to three SNMPv3 notification targets. Format is:
|
||
|
|
ip-or-hostname[\@port]/remote-user/security-level/trap|inform[,...].</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfigReadOnly">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPConfigReadOnly</tt><big>(</big><em>authentication=None</em>, <em>communities=None</em>, <em>enable=None</em>, <em>engineid=None</em>, <em>loglevel=None</em>, <em>notraps=None</em>, <em>port=None</em>, <em>privacy=None</em>, <em>syscontact=None</em>, <em>syslocation=None</em>, <em>targets=None</em>, <em>users=None</em>, <em>remoteusers=None</em>, <em>v3targets=None</em>, <em>pid=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfigReadOnly" 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">Snmp.SNMPConfigReadOnly</span></tt> class Structure that defines the SNMP
|
||
|
|
configuration, the result of get(), and never provided as input to set().
|
||
|
|
This structure differs from SNMPConfig because it contains localized keys
|
||
|
|
(as defined in <a class="reference external" href="http://tools.ietf.org/html/rfc3826#section-1.2">http://tools.ietf.org/html/rfc3826#section-1.2</a>), instead of
|
||
|
|
raw secret strings. This structure can be used to configure SNMP v1, v2c,
|
||
|
|
and v3. Keep this structure in sync with vmw_snmp.py:_default_config().
|
||
|
|
Note that if a field if left empty, it is considered unset and will be
|
||
|
|
ignored. Existing array elements below can be unset by sending an element
|
||
|
|
with the string ‘reset’.</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>authentication</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPAuthProto</span></tt></a>) – Set the default authentication protocol. Values can be none, MD5,
|
||
|
|
or SHA1.</li>
|
||
|
|
<li><strong>communities</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>) – Set up to ten communities, each of no more than 64 characters long.
|
||
|
|
The format is: community1[,community2,...]. This setting overwrites
|
||
|
|
any previous settings.</li>
|
||
|
|
<li><strong>enable</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Set enable to true/false</li>
|
||
|
|
<li><strong>engineid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Set SNMPv3 engine ID.</li>
|
||
|
|
<li><strong>loglevel</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System Agent syslog logging level: debug|info|warning|error.</li>
|
||
|
|
<li><strong>notraps</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>) – Comma-separated list of trap OIDs (object identifiers) for traps
|
||
|
|
not to be sent by the agent. Use ‘reset’ to clear the setting.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up a UDP port which the SNMP agent uses to listen on for
|
||
|
|
polling requests. The default UDP port is 161.</li>
|
||
|
|
<li><strong>privacy</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPPrivProto</span></tt></a>) – Set the default privacy protocol.</li>
|
||
|
|
<li><strong>syscontact</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System contact string as presented in sysContact.0. Up to 255
|
||
|
|
characters long.</li>
|
||
|
|
<li><strong>syslocation</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System location string as presented in sysLocation.0. Up to 255
|
||
|
|
characters long.</li>
|
||
|
|
<li><strong>targets</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.monitoring_client.Snmp.SNMPv1TrapTarget" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv1TrapTarget"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPv1TrapTarget</span></tt></a>) – Set up to three targets to which to send SNMPv1 traps.</li>
|
||
|
|
<li><strong>users</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.monitoring_client.Snmp.SNMPUser" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPUser"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPUser</span></tt></a>) – Set up to five local users.</li>
|
||
|
|
<li><strong>remoteusers</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.monitoring_client.Snmp.SNMPRemoteUser" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPRemoteUser"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPRemoteUser</span></tt></a>) – Set up remote users.</li>
|
||
|
|
<li><strong>v3targets</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.monitoring_client.Snmp.SNMPv3Target" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Target"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPv3Target</span></tt></a>) – Set up to three SNMPv3 notification targets. Format is:
|
||
|
|
ip-or-hostname[\@port]/remote-user/security-level/trap|inform[,...].</li>
|
||
|
|
<li><strong>pid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Set up pid</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashConfig">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPHashConfig</tt><big>(</big><em>auth_hash=None</em>, <em>priv_hash=None</em>, <em>raw_secret=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashConfig" 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">Snmp.SNMPHashConfig</span></tt> class Structure to provide up to two secrets to
|
||
|
|
combine with the SNMPv3 engine ID and authentication or privacy protocol to
|
||
|
|
form a localized hash. auth_hash is always required, priv_hash can be
|
||
|
|
empty. By default arguments are paths on the local filesystem, raw_secret
|
||
|
|
takes path to be the actual raw secret. First implementation was in ESXi:
|
||
|
|
esxcli system snmp hash –help</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>auth_hash</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Provide filename to secret for authentication hash, use in set
|
||
|
|
–users (required secret)</li>
|
||
|
|
<li><strong>priv_hash</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Provide filename to secret for privacy hash, use in set –users
|
||
|
|
(secret)</li>
|
||
|
|
<li><strong>raw_secret</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Make –auth_path and –priv_path flags read raw secret from command
|
||
|
|
line instead of file.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashResults">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPHashResults</tt><big>(</big><em>auth_key=None</em>, <em>priv_key=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashResults" 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">Snmp.SNMPHashResults</span></tt> class Structure to provide operators diagnostics
|
||
|
|
test results.</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>auth_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP authentication key</li>
|
||
|
|
<li><strong>priv_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP privacy key</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPLimits">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPLimits</tt><big>(</big><em>max_communities=None</em>, <em>max_trap_destinations_v1=None</em>, <em>max_destinations_v3=None</em>, <em>max_notification_filters=None</em>, <em>max_community_length=None</em>, <em>max_buffer_size=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPLimits" 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">Snmp.SNMPLimits</span></tt> class Structure that provides various limits of the
|
||
|
|
SNMP agent.</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>max_communities</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up maximum communities limit</li>
|
||
|
|
<li><strong>max_trap_destinations_v1</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up max trap destinations limit</li>
|
||
|
|
<li><strong>max_destinations_v3</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up max destinations limit</li>
|
||
|
|
<li><strong>max_notification_filters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up max notification Filters</li>
|
||
|
|
<li><strong>max_community_length</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up max community length</li>
|
||
|
|
<li><strong>max_buffer_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Set up max buffer size</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPPrivProto</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto" 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">Snmp.SNMPPrivProto</span></tt> class Defines SNMP privacy protocols</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">SNMPPrivProto</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto.AES128">
|
||
|
|
<tt class="descname">AES128</tt><em class="property"> = SNMPPrivProto(string=u'AES128')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto.AES128" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>AES128</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto.none">
|
||
|
|
<tt class="descname">none</tt><em class="property"> = SNMPPrivProto(string=u'none')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto.none" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>NONE</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPRemoteUser">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPRemoteUser</tt><big>(</big><em>username=None</em>, <em>sec_level=None</em>, <em>authentication=None</em>, <em>auth_key=None</em>, <em>privacy=None</em>, <em>priv_key=None</em>, <em>engineid=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPRemoteUser" 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">Snmp.SNMPRemoteUser</span></tt> class Structure that defines a user at particular
|
||
|
|
remote SNMPv3 entity needed when using informs. auth_key and priv_key
|
||
|
|
contained localized keys as defined in
|
||
|
|
<a class="reference external" href="http://tools.ietf.org/html/rfc3826#section-1.2">http://tools.ietf.org/html/rfc3826#section-1.2</a>.</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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP Username</li>
|
||
|
|
<li><strong>sec_level</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPSecLevel</span></tt></a>) – SNMP security level</li>
|
||
|
|
<li><strong>authentication</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPAuthProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPAuthProto</span></tt></a>) – SNMP authorization protocol</li>
|
||
|
|
<li><strong>auth_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP authorization key</li>
|
||
|
|
<li><strong>privacy</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPPrivProto"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPPrivProto</span></tt></a>) – SNMP privacy protocol</li>
|
||
|
|
<li><strong>priv_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP privacy key</li>
|
||
|
|
<li><strong>engineid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP v3 engine id</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPSecLevel</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel" 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">Snmp.SNMPSecLevel</span></tt> class Defines SNMP decurity 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">SNMPSecLevel</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.auth">
|
||
|
|
<tt class="descname">auth</tt><em class="property"> = SNMPSecLevel(string=u'auth')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.auth" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>auth</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.none">
|
||
|
|
<tt class="descname">none</tt><em class="property"> = SNMPSecLevel(string=u'none')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.none" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>none</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.priv">
|
||
|
|
<tt class="descname">priv</tt><em class="property"> = SNMPSecLevel(string=u'priv')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel.priv" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>priv</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPStats">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPStats</tt><big>(</big><em>sysuptime=None</em>, <em>worstrtimelast=None</em>, <em>avgresponsetime=None</em>, <em>worstresponsetime=None</em>, <em>inpkts=None</em>, <em>outpkts=None</em>, <em>usmstatsnotintimewindows=None</em>, <em>usmstatsunknownusernames=None</em>, <em>usmstatsunknownengineids=None</em>, <em>usmstatswrongdigests=None</em>, <em>usmstatsdecryptionerrors=None</em>, <em>inbadversions=None</em>, <em>inbadcommunitynames=None</em>, <em>inbadcommunityuses=None</em>, <em>inasnparseerrs=None</em>, <em>intoobigs=None</em>, <em>innosuchnames=None</em>, <em>inbadvalues=None</em>, <em>ingenerrs=None</em>, <em>outtoobigs=None</em>, <em>outnosuchnames=None</em>, <em>outbadvalues=None</em>, <em>outgenerrs=None</em>, <em>outtraps=None</em>, <em>silentdrops=None</em>, <em>avgvarbinds=None</em>, <em>maxvarbinds=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPStats" 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">Snmp.SNMPStats</span></tt> class Structure to provide operators diagnostics on snmp
|
||
|
|
agent itself.</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>sysuptime</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – System uptime</li>
|
||
|
|
<li><strong>worstrtimelast</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Last updated time</li>
|
||
|
|
<li><strong>avgresponsetime</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Average response time</li>
|
||
|
|
<li><strong>worstresponsetime</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Response time</li>
|
||
|
|
<li><strong>inpkts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of input packets</li>
|
||
|
|
<li><strong>outpkts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of output packets</li>
|
||
|
|
<li><strong>usmstatsnotintimewindows</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of stats not in time window</li>
|
||
|
|
<li><strong>usmstatsunknownusernames</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of usm stats unknown</li>
|
||
|
|
<li><strong>usmstatsunknownengineids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of usm stats unknown engine ids</li>
|
||
|
|
<li><strong>usmstatswrongdigests</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of wrogn digests</li>
|
||
|
|
<li><strong>usmstatsdecryptionerrors</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No. of decryption errors</li>
|
||
|
|
<li><strong>inbadversions</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of bad versions</li>
|
||
|
|
<li><strong>inbadcommunitynames</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of bad community names</li>
|
||
|
|
<li><strong>inbadcommunityuses</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of bad community uses</li>
|
||
|
|
<li><strong>inasnparseerrs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of parse errors</li>
|
||
|
|
<li><strong>intoobigs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of too bigs</li>
|
||
|
|
<li><strong>innosuchnames</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of no such names</li>
|
||
|
|
<li><strong>inbadvalues</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of bad values</li>
|
||
|
|
<li><strong>ingenerrs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of gen errors</li>
|
||
|
|
<li><strong>outtoobigs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No out output too bigs</li>
|
||
|
|
<li><strong>outnosuchnames</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of no such names</li>
|
||
|
|
<li><strong>outbadvalues</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of bad values</li>
|
||
|
|
<li><strong>outgenerrs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of gen errors</li>
|
||
|
|
<li><strong>outtraps</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of output traps</li>
|
||
|
|
<li><strong>silentdrops</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of silent drops</li>
|
||
|
|
<li><strong>avgvarbinds</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of ave:rage var binds</li>
|
||
|
|
<li><strong>maxvarbinds</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – No of max var binds</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPTestResults">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPTestResults</tt><big>(</big><em>success=None</em>, <em>message=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPTestResults" 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">Snmp.SNMPTestResults</span></tt> class Structure to provide operators diagnostics
|
||
|
|
test results.</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>success</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Set success to true/false</li>
|
||
|
|
<li><strong>message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – message</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPUser">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPUser</tt><big>(</big><em>username=None</em>, <em>sec_level=None</em>, <em>auth_key=None</em>, <em>priv_key=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPUser" 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">Snmp.SNMPUser</span></tt> class Structure that defines information associated with
|
||
|
|
an SNMP user. authKey and privKey are localized keys defined in
|
||
|
|
<a class="reference external" href="http://tools.ietf.org/html/rfc3826#section-1.2">http://tools.ietf.org/html/rfc3826#section-1.2</a>.</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>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP Username</li>
|
||
|
|
<li><strong>sec_level</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPSecLevel</span></tt></a>) – SNMP security level</li>
|
||
|
|
<li><strong>auth_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP authorization key</li>
|
||
|
|
<li><strong>priv_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP privacy key</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv1TrapTarget">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPv1TrapTarget</tt><big>(</big><em>ip=None</em>, <em>port=None</em>, <em>community=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv1TrapTarget" 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">Snmp.SNMPv1TrapTarget</span></tt> class Structure that defines an SNMP v1/v2c trap
|
||
|
|
target.</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>ip</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP target ip</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – SNMP target port</li>
|
||
|
|
<li><strong>community</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP target community</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPv3Notfication</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication" 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">Snmp.SNMPv3Notfication</span></tt> class Defines SNMP v3 notification types</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">SNMPv3Notfication</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication.inform">
|
||
|
|
<tt class="descname">inform</tt><em class="property"> = SNMPv3Notfication(string=u'inform')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication.inform" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>inform</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication.trap">
|
||
|
|
<tt class="descname">trap</tt><em class="property"> = SNMPv3Notfication(string=u'trap')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication.trap" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>trap</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Target">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Snmp.</tt><tt class="descname">SNMPv3Target</tt><big>(</big><em>type=None</em>, <em>sec_level=None</em>, <em>ip=None</em>, <em>port=None</em>, <em>user=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Target" 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">Snmp.SNMPv3Target</span></tt> class Structure that defines an SNMP v3 inform or
|
||
|
|
trap target.</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>type</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPv3Notfication"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPv3Notfication</span></tt></a>) – SNMP target type</li>
|
||
|
|
<li><strong>sec_level</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPSecLevel"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPSecLevel</span></tt></a>) – SNMP security level</li>
|
||
|
|
<li><strong>ip</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP target ip</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – SNMP target port</li>
|
||
|
|
<li><strong>user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – SNMP User</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.disable">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">disable</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.disable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Stop an enabled SNMP agent.</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.monitoring_client.Snmp.enable">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">enable</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.enable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Start a disabled SNMP agent.</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.monitoring_client.Snmp.get">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return an SNMP agent 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.monitoring_client.Snmp.SNMPConfigReadOnly" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfigReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPConfigReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SNMP config structure</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.monitoring_client.Snmp.hash">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">hash</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.hash" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Generate localized keys for secure SNMPv3 communications.</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.monitoring_client.Snmp.SNMPHashConfig" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashConfig"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPHashConfig</span></tt></a>) – SNMP hash configuration.</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.monitoring_client.Snmp.SNMPHashResults" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPHashResults"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPHashResults</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">SNMP hash result</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.monitoring_client.Snmp.limits">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">limits</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.limits" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get SNMP limits information.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPLimits" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPLimits"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPLimits</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SNMP limits structure</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.monitoring_client.Snmp.reset">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.reset" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Restore settings to factory defaults.</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.monitoring_client.Snmp.set">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set SNMP 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.monitoring_client.Snmp.SNMPConfig" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPConfig"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPConfig</span></tt></a>) – SNMP 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>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.monitoring_client.Snmp.stats">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">stats</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.stats" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Generate diagnostics report for snmp agent.</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.monitoring_client.Snmp.SNMPStats" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPStats"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPStats</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SNMP stats</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.monitoring_client.Snmp.test">
|
||
|
|
<tt class="descclassname">Snmp.</tt><tt class="descname">test</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.monitoring_client.Snmp.test" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Send a warmStart notification to all configured traps and inform
|
||
|
|
destinations (see RFC 3418).</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.monitoring_client.Snmp.SNMPTestResults" title="com.vmware.appliance.techpreview.monitoring_client.Snmp.SNMPTestResults"><tt class="xref py py-class docutils literal"><span class="pre">Snmp.SNMPTestResults</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SNMP test result</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.networking_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-networking-client-module"></span><h2>com.vmware.appliance.techpreview.networking_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.networking_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.networking_client.</tt><tt class="descname">Ipv4</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4" 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">Ipv4</span></tt> class provides methods Performs IPV4 network configuration for
|
||
|
|
interfaces.</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.networking_client.Ipv4.IPv4Config">
|
||
|
|
<em class="property">class </em><tt class="descname">IPv4Config</tt><big>(</big><em>interface_name=None</em>, <em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Config" 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">Ipv4.IPv4Config</span></tt> class Structure that defines the IPv4 configuration
|
||
|
|
state 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>interface_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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode" title="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode"><tt class="xref py py-class docutils literal"><span class="pre">Ipv4.IPv4Mode</span></tt></a>) – Address assignment mode.</li>
|
||
|
|
<li><strong>address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv4 address, for example, “10.20.80.191”. Set this argument to an
|
||
|
|
empty string “”, if the mode is “unconfigured” or “dhcp”.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – IPv4 CIDR prefix, for example , 24. See
|
||
|
|
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
|
||
|
|
conversion. Set this argument to 0 if the mode is “unconfigured” or
|
||
|
|
“dhcp”.</li>
|
||
|
|
<li><strong>default_gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv4 address of the default gateway. This default gateway value is
|
||
|
|
used if the mode argument is set to “static” This configures the
|
||
|
|
global default gateway on the appliance with the specified gateway
|
||
|
|
address and interface. This gateway replaces the existing default
|
||
|
|
gateway configured on the appliance. However, if the gateway
|
||
|
|
address is link-local, then it is added for that interface. This
|
||
|
|
does not support configuration of multiple global default gateways
|
||
|
|
through different interfaces.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4ConfigReadOnly">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv4.</tt><tt class="descname">IPv4ConfigReadOnly</tt><big>(</big><em>interface_name=None</em>, <em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em>, <em>updateable=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4ConfigReadOnly" 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">Ipv4.IPv4ConfigReadOnly</span></tt> class Structure that defines the IPv4
|
||
|
|
configuration state 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>interface_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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode" title="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode"><tt class="xref py py-class docutils literal"><span class="pre">Ipv4.IPv4Mode</span></tt></a>) – Address assignment mode.</li>
|
||
|
|
<li><strong>address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv4 address, for example, “10.20.80.191”. Set this argument to an
|
||
|
|
empty string “”, if the mode is “unconfigured” or “dhcp”.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – IPv4 CIDR prefix, for example , 24. See
|
||
|
|
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
|
||
|
|
conversion. Set this argument to 0 if the mode is “unconfigured” or
|
||
|
|
“dhcp”.</li>
|
||
|
|
<li><strong>default_gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv4 address of the default gateway. This default gateway value is
|
||
|
|
used if the mode argument is set to “static” This configures the
|
||
|
|
global default gateway on the appliance with the specified gateway
|
||
|
|
address and interface. This gateway replaces the existing default
|
||
|
|
gateway configured on the appliance. However, if the gateway
|
||
|
|
address is link-local, then it is added for that interface. This
|
||
|
|
does not support configuration of multiple global default gateways
|
||
|
|
through different interfaces.</li>
|
||
|
|
<li><strong>updateable</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – This indicates if the network configuration can be updated for the
|
||
|
|
interface.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv4.</tt><tt class="descname">IPv4Mode</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode" 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">Ipv4.IPv4Mode</span></tt> class Defines different ipv4 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">IPv4Mode</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.dhcp">
|
||
|
|
<tt class="descname">dhcp</tt><em class="property"> = IPv4Mode(string=u'dhcp')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.dhcp" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>IPv4 address is automatically assigned by a DHCP server.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.is_static">
|
||
|
|
<tt class="descname">is_static</tt><em class="property"> = IPv4Mode(string=u'is_static')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.is_static" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>IPv4 address is static.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.unconfigured">
|
||
|
|
<tt class="descname">unconfigured</tt><em class="property"> = IPv4Mode(string=u'unconfigured')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Mode.unconfigured" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv4 protocol is not configured.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv4.get">
|
||
|
|
<tt class="descclassname">Ipv4.</tt><tt class="descname">get</tt><big>(</big><em>interfaces</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get IPv4 network configuration for interfaces.</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>interfaces</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.list" title="com.vmware.appliance.techpreview.networking_client.Ipv4.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>) – Network interfaces to query, for example, “nic0”.</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.networking_client.Ipv4.list" title="com.vmware.appliance.techpreview.networking_client.Ipv4.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.networking_client.Ipv4.IPv4ConfigReadOnly" title="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4ConfigReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Ipv4.IPv4ConfigReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">IPv4 configuration for each queried interface.</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.networking_client.Ipv4.list">
|
||
|
|
<tt class="descclassname">Ipv4.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get IPv4 network configuration for all configured interfaces.</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.networking_client.Ipv4.list" title="com.vmware.appliance.techpreview.networking_client.Ipv4.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.networking_client.Ipv4.IPv4ConfigReadOnly" title="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4ConfigReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Ipv4.IPv4ConfigReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">IPv4 configuration for each interface.</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.networking_client.Ipv4.renew">
|
||
|
|
<tt class="descclassname">Ipv4.</tt><tt class="descname">renew</tt><big>(</big><em>interfaces</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.renew" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Renew IPv4 network configuration on interfaces. If the interface is
|
||
|
|
configured to use DHCP for IP address assignment, the lease of the
|
||
|
|
interface is renewed.</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>interfaces</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.list" title="com.vmware.appliance.techpreview.networking_client.Ipv4.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>) – Interfaces to renew.</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.networking_client.Ipv4.set">
|
||
|
|
<tt class="descclassname">Ipv4.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv4.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set IPv4 network 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.networking_client.Ipv4.list" title="com.vmware.appliance.techpreview.networking_client.Ipv4.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.networking_client.Ipv4.IPv4Config" title="com.vmware.appliance.techpreview.networking_client.Ipv4.IPv4Config"><tt class="xref py py-class docutils literal"><span class="pre">Ipv4.IPv4Config</span></tt></a>) – List of IPv4 configurations.</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.networking_client.Ipv6">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.networking_client.</tt><tt class="descname">Ipv6</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6" 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">Ipv6</span></tt> class provides methods Performs IPV4 network configuration for
|
||
|
|
interfaces.</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.networking_client.Ipv6.IPv6Address">
|
||
|
|
<em class="property">class </em><tt class="descname">IPv6Address</tt><big>(</big><em>address=None</em>, <em>prefix=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6Address" 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">Ipv6.IPv6Address</span></tt> class Structure used to name an IPv6 address.</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>address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – IPv6 CIDR prefix, for example, 64.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv6.</tt><tt class="descname">IPv6AddressOrigin</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin" 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">Ipv6.IPv6AddressOrigin</span></tt> class Defines IPV6 address origin values</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">IPv6AddressOrigin</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.dhcp">
|
||
|
|
<tt class="descname">dhcp</tt><em class="property"> = IPv6AddressOrigin(string=u'dhcp')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.dhcp" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv6 address is assigned by a DHCP server. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.linklayer">
|
||
|
|
<tt class="descname">linklayer</tt><em class="property"> = IPv6AddressOrigin(string=u'linklayer')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.linklayer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration
|
||
|
|
(SLAAC). See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.manual">
|
||
|
|
<tt class="descname">manual</tt><em class="property"> = IPv6AddressOrigin(string=u'manual')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.manual" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv6 address was manually configured to a specified address, for,
|
||
|
|
example, by user configuration. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.other">
|
||
|
|
<tt class="descname">other</tt><em class="property"> = IPv6AddressOrigin(string=u'other')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.other" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC,
|
||
|
|
or random. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.random">
|
||
|
|
<tt class="descname">random</tt><em class="property"> = IPv6AddressOrigin(string=u'random')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin.random" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The IPv6 address is assigned randomly by the system. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressReadOnly">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv6.</tt><tt class="descname">IPv6AddressReadOnly</tt><big>(</big><em>address=None</em>, <em>prefix=None</em>, <em>origin=None</em>, <em>status=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressReadOnly" 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">Ipv6.IPv6AddressReadOnly</span></tt> class Structure that you can use to get
|
||
|
|
information about an IPv6 address along with its origin and status.</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>address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – IPv6 CIDR prefix, for example, 64.</li>
|
||
|
|
<li><strong>origin</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressOrigin"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6AddressOrigin</span></tt></a>) – Origin of the IPv6 address. For more information, see RFC 4293.</li>
|
||
|
|
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6AddressStatus</span></tt></a>) – Status of the IPv6 address. For more information, see RFC 4293.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv6.</tt><tt class="descname">IPv6AddressStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus" 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">Ipv6.IPv6AddressStatus</span></tt> class Defines IPV6 address status values</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">IPv6AddressStatus</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.deprecated">
|
||
|
|
<tt class="descname">deprecated</tt><em class="property"> = IPv6AddressStatus(string=u'deprecated')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.deprecated" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This is a valid but deprecated IPv6 address. Do not use this IPv6 address
|
||
|
|
as a source address in new communications, although packets addressed to
|
||
|
|
such an address are processed as expected. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.duplicate">
|
||
|
|
<tt class="descname">duplicate</tt><em class="property"> = IPv6AddressStatus(string=u'duplicate')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.duplicate" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This IPv6 address is not unique on the link. Do use this IPv6 address. See
|
||
|
|
RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.inaccessible">
|
||
|
|
<tt class="descname">inaccessible</tt><em class="property"> = IPv6AddressStatus(string=u'inaccessible')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.inaccessible" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This IPv6 address is inaccessible because the interface to which this
|
||
|
|
address is assigned is not operational. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.invalid">
|
||
|
|
<tt class="descname">invalid</tt><em class="property"> = IPv6AddressStatus(string=u'invalid')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.invalid" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This IPv6 address is not a valid address. It should not appear as the
|
||
|
|
destination or source address of a packet. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.optimistic">
|
||
|
|
<tt class="descname">optimistic</tt><em class="property"> = IPv6AddressStatus(string=u'optimistic')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.optimistic" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This IPv6 address is available for use, subject to restrictions, while its
|
||
|
|
uniqueness on a link is being verified. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.preferred">
|
||
|
|
<tt class="descname">preferred</tt><em class="property"> = IPv6AddressStatus(string=u'preferred')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.preferred" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This is a valid IPv6 address that can appear as the destination or source
|
||
|
|
address of a packet. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.tentative">
|
||
|
|
<tt class="descname">tentative</tt><em class="property"> = IPv6AddressStatus(string=u'tentative')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.tentative" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>This IPv6 address is in the process of being verified as unique. Do not use
|
||
|
|
addresses in this state for general communication. You can use them to
|
||
|
|
determine the uniqueness of the address. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.unknown">
|
||
|
|
<tt class="descname">unknown</tt><em class="property"> = IPv6AddressStatus(string=u'unknown')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressStatus.unknown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The status of this address cannot be determined. See RFC 4293.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6Config">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv6.</tt><tt class="descname">IPv6Config</tt><big>(</big><em>interface_name=None</em>, <em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6Config" 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">Ipv6.IPv6Config</span></tt> class Structure that you can use to configure IPv6 on a
|
||
|
|
particular interface. Because IPv6 permits multiple addresses per
|
||
|
|
interface, addresses can be assigned by DHCP, SLAAC, and can also be
|
||
|
|
statically assigned.</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>interface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Network interface, for example, “nic0” to configure.</li>
|
||
|
|
<li><strong>dhcp</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Address assigned by a DHCP server.</li>
|
||
|
|
<li><strong>autoconf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Address is assigned by Stateless Address Autoconfiguration (SLAAC).</li>
|
||
|
|
<li><strong>addresses</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.networking_client.Ipv6.IPv6Address" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6Address"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6Address</span></tt></a>) – A list of addresses to be statically assigned.</li>
|
||
|
|
<li><strong>default_gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Default gateway for static IP address assignment. This configures
|
||
|
|
the global IPv6 default gateway on the appliance with the specified
|
||
|
|
gateway address and interface. This gateway replaces the existing
|
||
|
|
default gateway configured on the appliance. However, if the
|
||
|
|
gateway address is link-local, then it is added for that interface.
|
||
|
|
This does not support configuration of multiple global default
|
||
|
|
gateways through different interfaces.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6ConfigReadOnly">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ipv6.</tt><tt class="descname">IPv6ConfigReadOnly</tt><big>(</big><em>interface_name=None</em>, <em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em>, <em>updateable=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6ConfigReadOnly" 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">Ipv6.IPv6ConfigReadOnly</span></tt> class Structure that defines an existing IPv6
|
||
|
|
configuration on a particular interface. This structure is read only.</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>interface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Network interface, for example, “nic0” queried.</li>
|
||
|
|
<li><strong>dhcp</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Address assigned by a DHCP server.</li>
|
||
|
|
<li><strong>autoconf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Address is assigned by Stateless Address Autoconfiguration (SLAAC).</li>
|
||
|
|
<li><strong>addresses</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.networking_client.Ipv6.IPv6AddressReadOnly" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6AddressReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6AddressReadOnly</span></tt></a>) – A list of all addresses assigned to this interface. The origin
|
||
|
|
field of each address determines how the address was assigned, for
|
||
|
|
example, statically, by DHCP, SLAAC.</li>
|
||
|
|
<li><strong>default_gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Default gateway. This configures the global IPv6 default gateway on
|
||
|
|
the appliance with the specified gateway address and interface.
|
||
|
|
This gateway replaces the existing default gateway configured on
|
||
|
|
the appliance. However, if the gateway address is link-local, then
|
||
|
|
it is added for that interface. This does not support configuration
|
||
|
|
of multiple global default gateways through different interfaces.</li>
|
||
|
|
<li><strong>updateable</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – This indicates if the network configuration can be updated for the
|
||
|
|
interface.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.get">
|
||
|
|
<tt class="descclassname">Ipv6.</tt><tt class="descname">get</tt><big>(</big><em>interfaces</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get IPv6 network configuration for interfaces.</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>interfaces</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.list" title="com.vmware.appliance.techpreview.networking_client.Ipv6.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>) – Network interfaces to query, for example, “nic0”.</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.networking_client.Ipv6.list" title="com.vmware.appliance.techpreview.networking_client.Ipv6.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.networking_client.Ipv6.IPv6ConfigReadOnly" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6ConfigReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6ConfigReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">IPv6 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>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Ipv6.list">
|
||
|
|
<tt class="descclassname">Ipv6.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get IPv6 network configuration for all configured interfaces.</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.networking_client.Ipv6.list" title="com.vmware.appliance.techpreview.networking_client.Ipv6.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.networking_client.Ipv6.IPv6ConfigReadOnly" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6ConfigReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6ConfigReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">IPv6 configuration for each interface.</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.networking_client.Ipv6.set">
|
||
|
|
<tt class="descclassname">Ipv6.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Ipv6.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set IPv6 network 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.networking_client.Ipv6.list" title="com.vmware.appliance.techpreview.networking_client.Ipv6.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.networking_client.Ipv6.IPv6Config" title="com.vmware.appliance.techpreview.networking_client.Ipv6.IPv6Config"><tt class="xref py py-class docutils literal"><span class="pre">Ipv6.IPv6Config</span></tt></a>) – IPv6 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.techpreview.networking_client.Proxy">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.networking_client.</tt><tt class="descname">Proxy</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy" 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">Proxy</span></tt> class provides methods Proxy 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.networking_client.Proxy.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.networking_client.Proxy.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">Proxy.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.networking_client.Proxy.MessageStatus" title="com.vmware.appliance.techpreview.networking_client.Proxy.MessageStatus"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.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.networking_client.Proxy.MessageStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">MessageStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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">Proxy.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.networking_client.Proxy.MessageStatus.failure">
|
||
|
|
<tt class="descname">failure</tt><em class="property"> = MessageStatus(string=u'failure')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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.networking_client.Proxy.MessageStatus.success">
|
||
|
|
<tt class="descname">success</tt><em class="property"> = MessageStatus(string=u'success')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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.networking_client.Proxy.ProxyConfig">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">ProxyConfig</tt><big>(</big><em>protocol=None</em>, <em>server=None</em>, <em>port=None</em>, <em>username=None</em>, <em>password=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfig" 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">Proxy.ProxyConfig</span></tt> class Structure that defines proxy 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>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyProtocol</span></tt></a>) – protocol being configured.</li>
|
||
|
|
<li><strong>server</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – hostname or ip of proxy server</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – port to connect to the proxy server on. A value of -1 indicates
|
||
|
|
that the default port is being used.</li>
|
||
|
|
<li><strong>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – username for proxy server.</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – password for proxy server.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigMultiple">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">ProxyConfigMultiple</tt><big>(</big><em>status=None</em>, <em>configlist=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigMultiple" 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">Proxy.ProxyConfigMultiple</span></tt> class Structure representing multiple proxy
|
||
|
|
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.networking_client.Proxy.ProxyStatus" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyStatus</span></tt></a>) – proxy enabled or disabled This sets whether the proxy configuration
|
||
|
|
is used.</li>
|
||
|
|
<li><strong>configlist</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.networking_client.Proxy.ProxyConfig" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfig"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyConfig</span></tt></a>) – List of proxy configuration.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigTest">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">ProxyConfigTest</tt><big>(</big><em>protocol=None</em>, <em>server=None</em>, <em>port=None</em>, <em>username=None</em>, <em>password=None</em>, <em>testhost=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigTest" 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">Proxy.ProxyConfigTest</span></tt> class Structure that defines proxy 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>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyProtocol</span></tt></a>) – protocol being configured.</li>
|
||
|
|
<li><strong>server</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – hostname or ip of proxy server</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – port to connect to the proxy server on. A value of -1 indicates
|
||
|
|
that the default port is being used.</li>
|
||
|
|
<li><strong>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – username for proxy server.</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – password for proxy server.</li>
|
||
|
|
<li><strong>testhost</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Verify that a hostname (www.vmware.com) or IPv4 or Ipv6 address of
|
||
|
|
the testhost is accessible through proxy.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">ProxyProtocol</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol" 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">Proxy.ProxyProtocol</span></tt> class Defines different proxy protocols</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">ProxyProtocol</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.ftp">
|
||
|
|
<tt class="descname">ftp</tt><em class="property"> = ProxyProtocol(string=u'ftp')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.ftp" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>proxy configuration for ftp.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.http">
|
||
|
|
<tt class="descname">http</tt><em class="property"> = ProxyProtocol(string=u'http')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.http" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>proxy configuration for http.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.https">
|
||
|
|
<tt class="descname">https</tt><em class="property"> = ProxyProtocol(string=u'https')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol.https" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>proxy configuration for https.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">ProxyStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus" 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">Proxy.ProxyStatus</span></tt> class Defines state of proxy</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">ProxyStatus</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus.disabled">
|
||
|
|
<tt class="descname">disabled</tt><em class="property"> = ProxyStatus(string=u'disabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus.disabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>proxy configuration is disabled</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus.enabled">
|
||
|
|
<tt class="descname">enabled</tt><em class="property"> = ProxyStatus(string=u'enabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyStatus.enabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>proxy configuration is enabled</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.TestStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</tt><tt class="descname">TestStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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">Proxy.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.networking_client.Proxy.TestStatus.green">
|
||
|
|
<tt class="descname">green</tt><em class="property"> = TestStatus(string=u'green')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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.networking_client.Proxy.TestStatus.orange">
|
||
|
|
<tt class="descname">orange</tt><em class="property"> = TestStatus(string=u'orange')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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.networking_client.Proxy.TestStatus.red">
|
||
|
|
<tt class="descname">red</tt><em class="property"> = TestStatus(string=u'red')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.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.networking_client.Proxy.TestStatusInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Proxy.</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.networking_client.Proxy.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">Proxy.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.networking_client.Proxy.TestStatus" title="com.vmware.appliance.techpreview.networking_client.Proxy.TestStatus"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.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.networking_client.Proxy.Message" title="com.vmware.appliance.techpreview.networking_client.Proxy.Message"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.Message</span></tt></a>) – messages</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Proxy.delete">
|
||
|
|
<tt class="descclassname">Proxy.</tt><tt class="descname">delete</tt><big>(</big><em>protocol</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Delete a Proxy configuration for a specific protocol.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyProtocol</span></tt></a>) – Protocol to delete proxy of.</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.networking_client.Proxy.get">
|
||
|
|
<tt class="descclassname">Proxy.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get proxy configuration for all protocols.</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.networking_client.Proxy.ProxyConfigMultiple" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigMultiple"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyConfigMultiple</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">proxy configuration for all protocols.</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.networking_client.Proxy.set">
|
||
|
|
<tt class="descclassname">Proxy.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set Proxy configuration. In order for this configuration to take effect
|
||
|
|
a logout is required.</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.networking_client.Proxy.ProxyConfigMultiple" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigMultiple"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyConfigMultiple</span></tt></a>) – List of Proxy configurations to be set.</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.networking_client.Proxy.test">
|
||
|
|
<tt class="descclassname">Proxy.</tt><tt class="descname">test</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Proxy.test" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Test a Proxy configuration by testing the connection to the proxy
|
||
|
|
server and test host.</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.networking_client.Proxy.ProxyConfigTest" title="com.vmware.appliance.techpreview.networking_client.Proxy.ProxyConfigTest"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.ProxyConfigTest</span></tt></a>) – Proxy configuration to test</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.networking_client.Proxy.TestStatusInfo" title="com.vmware.appliance.techpreview.networking_client.Proxy.TestStatusInfo"><tt class="xref py py-class docutils literal"><span class="pre">Proxy.TestStatusInfo</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Status of proxy settings.</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.networking_client.Routes">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.networking_client.</tt><tt class="descname">Routes</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes" 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">Routes</span></tt> class provides methods Performs networking routes 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.techpreview.networking_client.Routes.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.networking_client.Routes.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">Routes.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.networking_client.Routes.MessageStatus" title="com.vmware.appliance.techpreview.networking_client.Routes.MessageStatus"><tt class="xref py py-class docutils literal"><span class="pre">Routes.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.networking_client.Routes.MessageStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Routes.</tt><tt class="descname">MessageStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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">Routes.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.networking_client.Routes.MessageStatus.failure">
|
||
|
|
<tt class="descname">failure</tt><em class="property"> = MessageStatus(string=u'failure')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.MessageStatus.success">
|
||
|
|
<tt class="descname">success</tt><em class="property"> = MessageStatus(string=u'success')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.Route">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Routes.</tt><tt class="descname">Route</tt><big>(</big><em>destination=None</em>, <em>prefix=None</em>, <em>gateway=None</em>, <em>interface_name=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.Route" 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">Routes.Route</span></tt> class Structure that describes how routing is performed
|
||
|
|
for a particular destination and prefix. A destination/prefix of 0.0.0.0/0
|
||
|
|
( for IPv4) or ::/0 (for IPv6) refers to the default gateway.</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>destination</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Destination address that defines this route.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Destination CIDR prefix that defines this route. See
|
||
|
|
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
|
||
|
|
conversion.</li>
|
||
|
|
<li><strong>gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Gateway address.</li>
|
||
|
|
<li><strong>interface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Output device interface, for example, “nic0”.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Routes.RouteReadOnly">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Routes.</tt><tt class="descname">RouteReadOnly</tt><big>(</big><em>destination=None</em>, <em>prefix=None</em>, <em>gateway=None</em>, <em>interface_name=None</em>, <em>is_static=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.RouteReadOnly" 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">Routes.RouteReadOnly</span></tt> class Structure that describes how routing is
|
||
|
|
performed for a particular destination and prefix. A destination/prefix of
|
||
|
|
0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway.</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>destination</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Destination address that defines this route.</li>
|
||
|
|
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Destination CIDR prefix that defines this route. See
|
||
|
|
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
|
||
|
|
conversion.</li>
|
||
|
|
<li><strong>gateway</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Gateway address.</li>
|
||
|
|
<li><strong>interface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Output device interface, for example, “nic0”.</li>
|
||
|
|
<li><strong>is_static</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Static provides information about installation of the route. True
|
||
|
|
indicates the route was installed by the administrator. False
|
||
|
|
indicates the route was autoconfigured</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Routes.TestStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Routes.</tt><tt class="descname">TestStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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">Routes.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.networking_client.Routes.TestStatus.green">
|
||
|
|
<tt class="descname">green</tt><em class="property"> = TestStatus(string=u'green')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.TestStatus.orange">
|
||
|
|
<tt class="descname">orange</tt><em class="property"> = TestStatus(string=u'orange')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.TestStatus.red">
|
||
|
|
<tt class="descname">red</tt><em class="property"> = TestStatus(string=u'red')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.TestStatusInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Routes.</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.networking_client.Routes.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">Routes.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.networking_client.Routes.TestStatus" title="com.vmware.appliance.techpreview.networking_client.Routes.TestStatus"><tt class="xref py py-class docutils literal"><span class="pre">Routes.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.networking_client.Routes.Message" title="com.vmware.appliance.techpreview.networking_client.Routes.Message"><tt class="xref py py-class docutils literal"><span class="pre">Routes.Message</span></tt></a>) – messages</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.networking_client.Routes.add">
|
||
|
|
<tt class="descclassname">Routes.</tt><tt class="descname">add</tt><big>(</big><em>route</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.add" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for
|
||
|
|
IPv4) or destination of :: and prefix 0 (for IPv6) refers to the
|
||
|
|
default gateway.</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>route</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Routes.Route" title="com.vmware.appliance.techpreview.networking_client.Routes.Route"><tt class="xref py py-class docutils literal"><span class="pre">Routes.Route</span></tt></a>) – Static routing rule.</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.networking_client.Routes.delete">
|
||
|
|
<tt class="descclassname">Routes.</tt><tt class="descname">delete</tt><big>(</big><em>route</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Delete static routing rules.</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>route</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Routes.Route" title="com.vmware.appliance.techpreview.networking_client.Routes.Route"><tt class="xref py py-class docutils literal"><span class="pre">Routes.Route</span></tt></a>) – Static routing rule.</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.networking_client.Routes.list">
|
||
|
|
<tt class="descclassname">Routes.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get main routing table. A destination of 0.0.0.0 and prefix 0 (for
|
||
|
|
IPv4) or destination of :: and prefix 0 (for IPv6) refers to the
|
||
|
|
default gateway.</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.networking_client.Routes.list" title="com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.RouteReadOnly" title="com.vmware.appliance.techpreview.networking_client.Routes.RouteReadOnly"><tt class="xref py py-class docutils literal"><span class="pre">Routes.RouteReadOnly</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Routing table.</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.networking_client.Routes.set">
|
||
|
|
<tt class="descclassname">Routes.</tt><tt class="descname">set</tt><big>(</big><em>routes</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for
|
||
|
|
IPv4) or destination of :: and prefix 0 (for IPv6) refers to the
|
||
|
|
default gateway.</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>routes</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Routes.list" title="com.vmware.appliance.techpreview.networking_client.Routes.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.networking_client.Routes.Route" title="com.vmware.appliance.techpreview.networking_client.Routes.Route"><tt class="xref py py-class docutils literal"><span class="pre">Routes.Route</span></tt></a>) – Static routing rules.</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.networking_client.Routes.test">
|
||
|
|
<tt class="descclassname">Routes.</tt><tt class="descname">test</tt><big>(</big><em>gateways</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking_client.Routes.test" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Test connection to a list of gateways</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>gateways</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking_client.Routes.list" title="com.vmware.appliance.techpreview.networking_client.Routes.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>) – list of gateways.</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.networking_client.Routes.TestStatusInfo" title="com.vmware.appliance.techpreview.networking_client.Routes.TestStatusInfo"><tt class="xref py py-class docutils literal"><span class="pre">Routes.TestStatusInfo</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">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>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.appliance.techpreview.ntp_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-ntp-client-module"></span><h2>com.vmware.appliance.techpreview.ntp_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.ntp_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.ntp_client.Server">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.ntp_client.</tt><tt class="descname">Server</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.ntp_client.Server" 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">Server</span></tt> class provides methods Performs NTP 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="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.ntp_client.Server.add">
|
||
|
|
<tt class="descname">add</tt><big>(</big><em>servers</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.ntp_client.Server.add" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Add NTP servers. This command adds NTP servers to the configuration. If
|
||
|
|
the time synchronization is NTP-based, then NTP daemon is restarted to
|
||
|
|
reload the new NTP servers. Otherwise, this command just adds servers
|
||
|
|
to the NTP 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>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">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.ntp_client.Server.delete">
|
||
|
|
<tt class="descname">delete</tt><big>(</big><em>servers</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.ntp_client.Server.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Delete NTP servers. This command deletes NTP servers from the
|
||
|
|
configuration. If the time synchronization mode is NTP-based, the NTP
|
||
|
|
daemon is restarted to reload the new NTP configuration. Otherwise,
|
||
|
|
this command just deletes servers from the NTP 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>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 name or ip addresses of ntp servers.</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.ntp_client.Server.set">
|
||
|
|
<tt class="descname">set</tt><big>(</big><em>servers</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.ntp_client.Server.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set NTP servers. This command deletes old NTP servers from the
|
||
|
|
configuration and sets the input NTP servers in the configuration. If
|
||
|
|
the time synchronization is NTP-based, the NTP daemon is restarted to
|
||
|
|
reload the new NTP configuration. Otherwise, this command just replaces
|
||
|
|
servers in the NTP 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>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">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.services_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-services-client-module"></span><h2>com.vmware.appliance.techpreview.services_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.services_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.services_client.Status">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.services_client.</tt><tt class="descname">Status</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.services_client.Status" 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">Status</span></tt> class provides methods Get status 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>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.services_client.Status.ServiceStatus">
|
||
|
|
<em class="property">class </em><tt class="descname">ServiceStatus</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.services_client.Status.ServiceStatus" 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">Status.ServiceStatus</span></tt> class Defines service 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">ServiceStatus</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.services_client.Status.ServiceStatus.down">
|
||
|
|
<tt class="descname">down</tt><em class="property"> = ServiceStatus(string=u'down')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.services_client.Status.ServiceStatus.down" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Service is not running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.services_client.Status.ServiceStatus.up">
|
||
|
|
<tt class="descname">up</tt><em class="property"> = ServiceStatus(string=u'up')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.services_client.Status.ServiceStatus.up" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Service is running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.services_client.Status.get">
|
||
|
|
<tt class="descclassname">Status.</tt><tt class="descname">get</tt><big>(</big><em>name</em>, <em>timeout</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.services_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get status 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of a 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">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.appliance.techpreview.services_client.Status.ServiceStatus" title="com.vmware.appliance.techpreview.services_client.Status.ServiceStatus"><tt class="xref py py-class docutils literal"><span class="pre">Status.ServiceStatus</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Status of the service.</p>
|
||
|
|
</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>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.appliance.techpreview.system_client">
|
||
|
|
<span id="com-vmware-appliance-techpreview-system-client-module"></span><h2>com.vmware.appliance.techpreview.system_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.system_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.system_client.</tt><tt class="descname">Update</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update" 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">Update</span></tt> class provides methods Performs update repository 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.system_client.Update.AutoUpdateNotification">
|
||
|
|
<em class="property">class </em><tt class="descname">AutoUpdateNotification</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification" 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">Update.AutoUpdateNotification</span></tt> class Defines state for automatic update
|
||
|
|
notification</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">AutoUpdateNotification</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification.disabled">
|
||
|
|
<tt class="descname">disabled</tt><em class="property"> = AutoUpdateNotification(string=u'disabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification.disabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Automatic update notification is disabled. Disable periodically query the
|
||
|
|
configured url for updates.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification.enabled">
|
||
|
|
<tt class="descname">enabled</tt><em class="property"> = AutoUpdateNotification(string=u'enabled')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification.enabled" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Automatic update notification is enabled. Enable periodically query the
|
||
|
|
configured url for updates.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Update.</tt><tt class="descname">UpdateDay</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay" 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">Update.UpdateDay</span></tt> class Defines days to query for updates</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="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">UpdateDay</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Everyday">
|
||
|
|
<tt class="descname">Everyday</tt><em class="property"> = UpdateDay(string=u'Everyday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Everyday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates everyday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Friday">
|
||
|
|
<tt class="descname">Friday</tt><em class="property"> = UpdateDay(string=u'Friday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Friday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Friday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Monday">
|
||
|
|
<tt class="descname">Monday</tt><em class="property"> = UpdateDay(string=u'Monday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Monday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Monday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Saturday">
|
||
|
|
<tt class="descname">Saturday</tt><em class="property"> = UpdateDay(string=u'Saturday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Saturday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Saturday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Sunday">
|
||
|
|
<tt class="descname">Sunday</tt><em class="property"> = UpdateDay(string=u'Sunday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Sunday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Sunday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Thursday">
|
||
|
|
<tt class="descname">Thursday</tt><em class="property"> = UpdateDay(string=u'Thursday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Thursday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Thursday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Tuesday">
|
||
|
|
<tt class="descname">Tuesday</tt><em class="property"> = UpdateDay(string=u'Tuesday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Tuesday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Tuesday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Wednesday">
|
||
|
|
<tt class="descname">Wednesday</tt><em class="property"> = UpdateDay(string=u'Wednesday')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay.Wednesday" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>query for updates on Wednesday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateStructGet">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Update.</tt><tt class="descname">UpdateStructGet</tt><big>(</big><em>current_url=None</em>, <em>default_url=None</em>, <em>check_updates=None</em>, <em>time=None</em>, <em>day=None</em>, <em>latest_update_install_time=None</em>, <em>latest_update_query_time=None</em>, <em>username=None</em>, <em>password=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateStructGet" 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">Update.UpdateStructGet</span></tt> class Structure to get url update repository.</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>current_url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Current appliance update repository URL.</li>
|
||
|
|
<li><strong>default_url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Default appliance update repository URL.</li>
|
||
|
|
<li><strong>check_updates</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification" title="com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification"><tt class="xref py py-class docutils literal"><span class="pre">Update.AutoUpdateNotification</span></tt></a>) – Check for update at the pre-configured repository URL.</li>
|
||
|
|
<li><strong>time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – time to query for updates Format: HH:MM:SS Military (24 hour) Time
|
||
|
|
Format</li>
|
||
|
|
<li><strong>day</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay" title="com.vmware.appliance.techpreview.system_client.Update.UpdateDay"><tt class="xref py py-class docutils literal"><span class="pre">Update.UpdateDay</span></tt></a>) – day to query for updates</li>
|
||
|
|
<li><strong>latest_update_install_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – timestamp of latest update installation</li>
|
||
|
|
<li><strong>latest_update_query_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – timestamp of latest query to update repository</li>
|
||
|
|
<li><strong>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – username for the url update repository</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – password for the url update repository</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.UpdateStructSet">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Update.</tt><tt class="descname">UpdateStructSet</tt><big>(</big><em>current_url=None</em>, <em>check_updates=None</em>, <em>time=None</em>, <em>day=None</em>, <em>username=None</em>, <em>password=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateStructSet" 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">Update.UpdateStructSet</span></tt> class Structure to set url update repository.</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>current_url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Current appliance update repository URL. Enter “default” to reset
|
||
|
|
the url to the default url.</li>
|
||
|
|
<li><strong>check_updates</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification" title="com.vmware.appliance.techpreview.system_client.Update.AutoUpdateNotification"><tt class="xref py py-class docutils literal"><span class="pre">Update.AutoUpdateNotification</span></tt></a>) – Check for update at the pre-configured repository URL.</li>
|
||
|
|
<li><strong>time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – time to query for updates Format: HH:MM:SS Military (24 hour) Time
|
||
|
|
Format</li>
|
||
|
|
<li><strong>day</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.system_client.Update.UpdateDay" title="com.vmware.appliance.techpreview.system_client.Update.UpdateDay"><tt class="xref py py-class docutils literal"><span class="pre">Update.UpdateDay</span></tt></a>) – day to query for updates</li>
|
||
|
|
<li><strong>username</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – username for the url update repository</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – password for the url update repository</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.techpreview.system_client.Update.get">
|
||
|
|
<tt class="descclassname">Update.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get update repository 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.system_client.Update.UpdateStructGet" title="com.vmware.appliance.techpreview.system_client.Update.UpdateStructGet"><tt class="xref py py-class docutils literal"><span class="pre">Update.UpdateStructGet</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">update related 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.system_client.Update.set">
|
||
|
|
<tt class="descclassname">Update.</tt><tt class="descname">set</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.system_client.Update.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set update repository 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.system_client.Update.UpdateStructSet" title="com.vmware.appliance.techpreview.system_client.Update.UpdateStructSet"><tt class="xref py py-class docutils literal"><span class="pre">Update.UpdateStructSet</span></tt></a>) – update related 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.techpreview">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.appliance.techpreview" 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.techpreview 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.techpreview.localaccounts_client">com.vmware.appliance.techpreview.localaccounts_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.monitoring_client">com.vmware.appliance.techpreview.monitoring_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.networking_client">com.vmware.appliance.techpreview.networking_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.ntp_client">com.vmware.appliance.techpreview.ntp_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.services_client">com.vmware.appliance.techpreview.services_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.system_client">com.vmware.appliance.techpreview.system_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.recovery.html"
|
||
|
|
title="previous chapter">com.vmware.appliance.recovery package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.techpreview.networking.html"
|
||
|
|
title="next chapter">com.vmware.appliance.techpreview.networking package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.appliance.techpreview.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.techpreview.networking.html" title="com.vmware.appliance.techpreview.networking package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.recovery.html" title="com.vmware.appliance.recovery 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>
|
||
|
|
<li><a href="com.vmware.appliance.html" >com.vmware.appliance package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|