Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
968fbec7b4
vsphere-automation-sdk-python/vsphere/8.0.1.0/com.vmware.appliance.networking.html
Shweta 968fbec7b4
Referesh vsphere Docs for 8.0U1 release (#371) 
Signed-off-by: shweta purohit <spurohit@vmware.com>
2023-04-19 17:55:36 +05:30

1382 lines
118 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.appliance.networking package &mdash; vSphere Automation SDK for Python. 8.0.1.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.appliance.recovery package" href="com.vmware.appliance.recovery.html" />
<link rel="prev" title="com.vmware.appliance package" href="com.vmware.appliance.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.appliance.html">com.vmware.appliance package</a></li>
<li class="breadcrumb-item active">com.vmware.appliance.networking package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.appliance.networking.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-com.vmware.appliance.networking">
<span id="com-vmware-appliance-networking-package"></span><h1>com.vmware.appliance.networking package<a class="headerlink" href="#module-com.vmware.appliance.networking" title="Permalink to this headline"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-com.vmware.appliance.networking.dns_client">
<span id="com-vmware-appliance-networking-dns-client-module"></span><h2>com.vmware.appliance.networking.dns_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.dns_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Domains">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.dns_client.</span></span><span class="sig-name descname"><span class="pre">Domains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Domains</span></code> class provides methods DNS search domains.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Domains.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.add" title="Permalink to this definition"></a></dt>
<dd><p>Add domain to DNS search domains.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain to add.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Domains.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.list" title="Permalink to this definition"></a></dt>
<dd><p>Get list of DNS search domains.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Domains.list" title="com.vmware.appliance.networking.dns_client.Domains.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of domains.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Domains.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domains</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.set" title="Permalink to this definition"></a></dt>
<dd><p>Set DNS search domains.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>domains</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Domains.list" title="com.vmware.appliance.networking.dns_client.Domains.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of domains.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.dns_client.</span></span><span class="sig-name descname"><span class="pre">Hostname</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Hostname</span></code> class provides methods Performs operations on Fully Qualified
Doman Name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.Message">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Hostname.Message</span></code> class Test result and message</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – message</p></li>
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus" title="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hostname.MessageStatus</span></code></a>) – result of the test</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">MessageStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Hostname.MessageStatus</span></code> class Individual test result</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure">
<span class="sig-name descname"><span class="pre">failure</span></span><em class="property"> <span class="pre">=</span> <span class="pre">MessageStatus(string='failure')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure" title="Permalink to this definition"></a></dt>
<dd><p>message indicates the test failed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.success">
<span class="sig-name descname"><span class="pre">success</span></span><em class="property"> <span class="pre">=</span> <span class="pre">MessageStatus(string='success')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.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="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">TestStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Hostname.TestStatus</span></code> class Health indicator</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">TestStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.green">
<span class="sig-name descname"><span class="pre">green</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='green')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.green" title="Permalink to this definition"></a></dt>
<dd><p>All tests were successful for given data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.orange">
<span class="sig-name descname"><span class="pre">orange</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='orange')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.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="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red">
<span class="sig-name descname"><span class="pre">red</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='red')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red" title="Permalink to this definition"></a></dt>
<dd><p>All tests failed for given data</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">TestStatusInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Hostname.TestStatusInfo</span></code> class Overall test result</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus" title="com.vmware.appliance.networking.dns_client.Hostname.TestStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hostname.TestStatus</span></code></a>) – Overall status of tests run.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Hostname.Message" title="com.vmware.appliance.networking.dns_client.Hostname.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hostname.Message</span></code></a>) – messages</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the Fully Qualified Doman Name.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>FQDN.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.set" title="Permalink to this definition"></a></dt>
<dd><p>Set the Fully Qualified Domain Name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Hostname.test">
<span class="sig-name descname"><span class="pre">test</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.test" title="Permalink to this definition"></a></dt>
<dd><p>Test the Fully Qualified Domain Name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo" title="com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hostname.TestStatusInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>FQDN status</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.dns_client.</span></span><span class="sig-name descname"><span class="pre">Servers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers</span></code> class provides methods DNS server configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">DNSServerConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.DNSServerConfig</span></code> class This structure represents the
configuration state used to determine DNS servers.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode" title="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.DNSServerMode</span></code></a>) – Define how to determine the DNS servers. Leave the servers argument
empty if the mode argument is “DHCP”. Set the servers argument to a
comma-separated list of DNS servers if the mode argument is
“static”. The DNS server are assigned from the specified list.</p></li>
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of the currently used DNS servers.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">DNSServerMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.DNSServerMode</span></code> class Describes DNS Server source (DHCP,static)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DNSServerMode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.dhcp">
<span class="sig-name descname"><span class="pre">dhcp</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DNSServerMode(string='dhcp')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.dhcp" title="Permalink to this definition"></a></dt>
<dd><p>DNS address is automatically assigned by a DHCP server.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static">
<span class="sig-name descname"><span class="pre">is_static</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DNSServerMode(string='is_static')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static" title="Permalink to this definition"></a></dt>
<dd><p>DNS address is static.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.Message">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.Message</span></code> class Test result and message</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – message</p></li>
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus" title="com.vmware.appliance.networking.dns_client.Servers.MessageStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.MessageStatus</span></code></a>) – result of the test</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">MessageStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.MessageStatus</span></code> class Individual test result</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure">
<span class="sig-name descname"><span class="pre">failure</span></span><em class="property"> <span class="pre">=</span> <span class="pre">MessageStatus(string='failure')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure" title="Permalink to this definition"></a></dt>
<dd><p>message indicates the test failed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus.success">
<span class="sig-name descname"><span class="pre">success</span></span><em class="property"> <span class="pre">=</span> <span class="pre">MessageStatus(string='success')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.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="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.TestStatus">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">TestStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.TestStatus</span></code> class Health indicator</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">TestStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.green">
<span class="sig-name descname"><span class="pre">green</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='green')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.green" title="Permalink to this definition"></a></dt>
<dd><p>All tests were successful for given data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.orange">
<span class="sig-name descname"><span class="pre">orange</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='orange')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.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="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.red">
<span class="sig-name descname"><span class="pre">red</span></span><em class="property"> <span class="pre">=</span> <span class="pre">TestStatus(string='red')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.red" title="Permalink to this definition"></a></dt>
<dd><p>All tests failed for given data</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">TestStatusInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Servers.TestStatusInfo</span></code> class Overall test result</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus" title="com.vmware.appliance.networking.dns_client.Servers.TestStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.TestStatus</span></code></a>) – Overall status of tests run.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.Message" title="com.vmware.appliance.networking.dns_client.Servers.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.Message</span></code></a>) – messages</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.add" title="Permalink to this definition"></a></dt>
<dd><p>Add a DNS server. This method fails if mode argument is “dhcp”</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – DNS server.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.get" title="Permalink to this definition"></a></dt>
<dd><p>Get DNS server configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" title="com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.DNSServerConfig</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>DNS server configuration.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.set" title="Permalink to this definition"></a></dt>
<dd><p>Set the DNS server configuration. If you set the mode argument to
“DHCP”, a DHCP refresh is forced.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" title="com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.DNSServerConfig</span></code></a>) – DNS server configuration.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.Servers.test">
<span class="sig-name descname"><span class="pre">test</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.test" title="Permalink to this definition"></a></dt>
<dd><p>Test if dns servers are reachable.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – DNS servers.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo" title="com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Servers.TestStatusInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>DNS reacable status</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.dns_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.dns_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.appliance.networking.firewall_client">
<span id="com-vmware-appliance-networking-firewall-client-module"></span><h2>com.vmware.appliance.networking.firewall_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.firewall_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.firewall_client.</span></span><span class="sig-name descname"><span class="pre">Inbound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Inbound</span></code> class provides methods to manage inbound firewall rules.
This class was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Policy">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Policy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Inbound.Policy</span></code> class Defines firewall rule policies. This enumeration
was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Policy</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.ACCEPT">
<span class="sig-name descname"><span class="pre">ACCEPT</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='ACCEPT')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.ACCEPT" title="Permalink to this definition"></a></dt>
<dd><p>Allow packet with corresponding address. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.IGNORE">
<span class="sig-name descname"><span class="pre">IGNORE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='IGNORE')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.IGNORE" title="Permalink to this definition"></a></dt>
<dd><p>Drop packet with correpsonding address. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.REJECT">
<span class="sig-name descname"><span class="pre">REJECT</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='REJECT')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.REJECT" title="Permalink to this definition"></a></dt>
<dd><p>Drop packet with corresponding address sending destination is not
reachable. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.RETURN">
<span class="sig-name descname"><span class="pre">RETURN</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='RETURN')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.RETURN" title="Permalink to this definition"></a></dt>
<dd><p>Apply default or port-specific rules to packet with corresponding address.
This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.Rule">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Rule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interface_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Rule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Inbound.Rule</span></code> class Structure that defines a single address-based
firewall rule. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPv4 or IPv6 address. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – CIDR prefix used to mask address. For example, an IPv4 prefix of 24
ignores the low-order 8 bits of address. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>policy</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy" title="com.vmware.appliance.networking.firewall_client.Inbound.Policy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Inbound.Policy</span></code></a>) – The allow or deny policy of this rule. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The interface to which this rule applies. An empty string indicates
that the rule applies to all interfaces. This attribute was added
in vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the ordered list of firewall rules. Within the list of traffic
rules, rules are processed in order of appearance, from top to bottom.
When a connection matches a firewall rule, further processing for the
connection stops, and the appliance ignores any additional firewall
rules you have set. This method was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.firewall_client.Inbound.Rule" title="com.vmware.appliance.networking.firewall_client.Inbound.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">Inbound.Rule</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of address-based firewall rules.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.Inbound.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.set" title="Permalink to this definition"></a></dt>
<dd><p>Set the ordered list of firewall rules to allow or deny traffic from
one or more incoming IP addresses. This overwrites the existing
firewall rules and creates a new rule list. Within the list of traffic
rules, rules are processed in order of appearance, from top to bottom.
For example, the list of rules can be as follows:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 27%" />
<col style="width: 18%" />
<col style="width: 36%" />
<col style="width: 18%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Address</p></th>
<th class="head"><p>Prefix</p></th>
<th class="head"><p>Interface Name</p></th>
<th class="head"><p>Policy</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>10.112.0.1</p></td>
<td><p>0</p></td>
<td><p>*</p></td>
<td><p>REJECT</p></td>
</tr>
<tr class="row-odd"><td><p>10.112.0.1</p></td>
<td><p>0</p></td>
<td><p>nic0</p></td>
<td><p>ACCEPT</p></td>
</tr>
</tbody>
</table>
<p>In the above example, the first rule drops all packets originating from
10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on
nic0. In effect, the second rule is always ignored which is not
desired, hence the order has to be swapped. When a connection matches a
firewall rule, further processing for the connection stops, and the
appliance ignores any additional firewall rules you have set. This
method was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.firewall_client.Inbound.Rule" title="com.vmware.appliance.networking.firewall_client.Inbound.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">Inbound.Rule</span></code></a>) – List of address-based firewall rules.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.firewall_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.firewall_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.appliance.networking.interfaces_client">
<span id="com-vmware-appliance-networking-interfaces-client-module"></span><h2>com.vmware.appliance.networking.interfaces_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.interfaces_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.interfaces_client.</span></span><span class="sig-name descname"><span class="pre">Ipv4</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4</span></code> class provides methods to perform IPv4 network configuration
for interfaces. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Config">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Config" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4.Config</span></code> class provides defines the IPv4 configuration of a
network interface. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Mode</span></code></a>) – The Address assignment mode. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv4 address, for example, “10.20.80.191”. This attribute was
added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The 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. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.STATIC</span></code></a>.</p></li>
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The IPv4 address of the default gateway. 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. This attribute was added in vSphere API 6.7.
If None, the defaultGateway was never set.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configurable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4.Info</span></code> class defines current IPv4 configuration state of a
network interface. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>configurable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – The specified network interface is configurable or not. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Mode</span></code></a>) – The Address assignment mode. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv4 address, for example, “10.20.80.191”. This attribute was
added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is one of <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.STATIC</span></code></a> or
<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.DHCP</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The 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. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is one of <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.STATIC</span></code></a> or
<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.DHCP</span></code></a>.</p></li>
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv4 address of the default gateway. 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. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is one of <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.STATIC</span></code></a> or
<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Mode.DHCP</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4.Mode</span></code> class defines different IPv4 address assignment modes.
This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Mode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP">
<span class="sig-name descname"><span class="pre">DHCP</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>The IPv4 address is automatically assigned by a DHCP server. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC">
<span class="sig-name descname"><span class="pre">STATIC</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='STATIC')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="Permalink to this definition"></a></dt>
<dd><p>The IPv4 address is static. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.UNCONFIGURED">
<span class="sig-name descname"><span class="pre">UNCONFIGURED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='UNCONFIGURED')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.UNCONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>The IPv4 protocol is not configured. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.get" title="Permalink to this definition"></a></dt>
<dd><p>Get IPv4 network configuration for specific NIC. This method was added
in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The Network interface to query, for example, “nic0”.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Info" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The IPv4 configuration for the queried NIC.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified NIC is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv4.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.set" title="Permalink to this definition"></a></dt>
<dd><p>Set IPv4 network configuration for specific network interface. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Network interface to update, for example, “nic0”.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p></li>
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Config" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Config</span></code></a>) – The IPv4 Network configuration to set.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified NIC is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the IP is used as PNID</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the specified NIC is busy.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.interfaces_client.</span></span><span class="sig-name descname"><span class="pre">Ipv6</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6</span></code> class provides methods to perform IPv6 network configuration
for interfaces. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Address">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Address</span></code> class provides the structure used to name an IPv6
address. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The IPv6 CIDR prefix, for example, 64. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">AddressInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.AddressInfo</span></code> class provides the structure that you can use to
get information about an IPv6 address along with its origin and status.
This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>origin</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Origin</span></code></a>) – The Origin of the IPv6 address. For more information, see RFC 4293.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Status</span></code></a>) – The Status of the IPv6 address. For more information, see RFC 4293.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The IPv6 CIDR prefix, for example, 64. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Config">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dhcp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoconf</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addresses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Config" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Config</span></code> class provides the structure that you can use to
configure IPv6 on a particular interface. Addresses can be assigned by
DHCP, SLAAC or STATIC, as IPv6 permits multiple addresses per interface.
This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dhcp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – An address will be assigned by a DHCP server. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>autoconf</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – An address will be assigned by Stateless Address Autoconfiguration
(SLAAC). This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Address</span></code></a>) – The list of addresses to be statically assigned. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The 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. This attribute was
added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dhcp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoconf</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addresses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">configurable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Info</span></code> class provides the structure that defines an existing
IPv6 configuration on a particular interface. This structure is read only.
This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dhcp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – DHCP is on. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>autoconf</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Stateless Address Autoconfiguration (SLAAC) is on. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo" title="com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.AddressInfo</span></code></a>) – List of addresses with their origins and statuses. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The 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. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>configurable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is NIC configurable or not. This attribute was added in vSphere API
6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Origin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Origin</span></code> class defines IPv6 address origin values. This
enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Origin</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.DHCP">
<span class="sig-name descname"><span class="pre">DHCP</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is assigned by a DHCP server. See RFC 4293. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.LINKLAYER">
<span class="sig-name descname"><span class="pre">LINKLAYER</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='LINKLAYER')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.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. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.MANUAL">
<span class="sig-name descname"><span class="pre">MANUAL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.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. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.OTHER">
<span class="sig-name descname"><span class="pre">OTHER</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='OTHER')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.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. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.RANDOM">
<span class="sig-name descname"><span class="pre">RANDOM</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='RANDOM')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.RANDOM" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is assigned randomly by the system. See RFC 4293. This
class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Status</span></code> class defines IPv6 address status values. See RFC 4293.
This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DEPRECATED">
<span class="sig-name descname"><span class="pre">DEPRECATED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DEPRECATED')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DEPRECATED" title="Permalink to this definition"></a></dt>
<dd><p>The is a valid but deprecated IPv6 address. This address cannot be used as
a source address in new communications, although packets addressed to such
an address are processed as expected. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DUPLICATE">
<span class="sig-name descname"><span class="pre">DUPLICATE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DUPLICATE')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DUPLICATE" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is not unique on the link and cannot be used. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INACCESSIBLE">
<span class="sig-name descname"><span class="pre">INACCESSIBLE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='INACCESSIBLE')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INACCESSIBLE" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is inaccessible because the interface to which this
address is assigned is not operational. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INVALID">
<span class="sig-name descname"><span class="pre">INVALID</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is not a valid address. It should not appear as the
destination or source address of a packet. This class attribute was added
in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.OPTIMISTIC">
<span class="sig-name descname"><span class="pre">OPTIMISTIC</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='OPTIMISTIC')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.OPTIMISTIC" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is available for use, subject to restrictions, while its
uniqueness on a link is being verified. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.PREFERRED">
<span class="sig-name descname"><span class="pre">PREFERRED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='PREFERRED')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.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. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.TENTATIVE">
<span class="sig-name descname"><span class="pre">TENTATIVE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='TENTATIVE')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.TENTATIVE" title="Permalink to this definition"></a></dt>
<dd><p>The IPv6 address is in the process of being verified as unique. An address
in this state cannot be used for general communication. It can be used to
determine the uniqueness of the address. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.UNKNOWN">
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>The status of this address cannot be determined. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.get" title="Permalink to this definition"></a></dt>
<dd><p>Get IPv6 network configuration for specific interface. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Network interface to query, for example, “nic0”.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Info" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>IPv6 configuration.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified NIC is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.Ipv6.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.set" title="Permalink to this definition"></a></dt>
<dd><p>Set IPv6 network configuration for specific interface. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Network interface to update, for example, “nic0”.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p></li>
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Config" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Config</span></code></a>) – The IPv6 configuration.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
The specified NIC is busy.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
The specified NIC is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.appliance.networking.interfaces_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.appliance.networking.interfaces_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.appliance.html" class="btn btn-neutral float-left" title="com.vmware.appliance package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.appliance.recovery.html" class="btn btn-neutral float-right" title="com.vmware.appliance.recovery package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, VMware, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink