<spanid="com-vmware-appliance-networking-package"></span><h1>com.vmware.appliance.networking package<aclass="headerlink"href="#module-com.vmware.appliance.networking"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-appliance-networking-dns-client-module"></span><h2>com.vmware.appliance.networking.dns_client module<aclass="headerlink"href="#module-com.vmware.appliance.networking.dns_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.dns_client.</code><codeclass="descname">Domains</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Domains"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">add</code><spanclass="sig-paren">(</span><em>domain</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Domains.add"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Domains.list"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>domains</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Domains.set"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.dns_client.</code><codeclass="descname">Hostname</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Message</code><spanclass="sig-paren">(</span><em>message=None</em>, <em>result=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.Message"title="Permalink to this definition">¶</a></dt>
<li><strong>result</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus"title="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hostname.MessageStatus</span></code></a>) – result of the test</li>
<emclass="property">class </em><codeclass="descname">MessageStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Hostname.MessageStatus</span></code> class Individual test result</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">failure</code><emclass="property"> = MessageStatus(string='failure')</em><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">success</code><emclass="property"> = MessageStatus(string='success')</em><aclass="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>
<emclass="property">class </em><codeclass="descname">TestStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Hostname.TestStatus</span></code> class Health indicator</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">green</code><emclass="property"> = TestStatus(string='green')</em><aclass="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>
<codeclass="descname">orange</code><emclass="property"> = TestStatus(string='orange')</em><aclass="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
<codeclass="descname">red</code><emclass="property"> = TestStatus(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">TestStatusInfo</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.set"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">test</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Hostname.test"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.dns_client.</code><codeclass="descname">Servers</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">DNSServerConfig</code><spanclass="sig-paren">(</span><em>mode=None</em>, <em>servers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode"title="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of the currently used DNS servers.</li>
<emclass="property">class </em><codeclass="descname">DNSServerMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Servers.DNSServerMode</span></code> class Describes DNS Server source (DHCP,static)</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">dhcp</code><emclass="property"> = DNSServerMode(string='dhcp')</em><aclass="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>
<codeclass="descname">is_static</code><emclass="property"> = DNSServerMode(string='is_static')</em><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">Message</code><spanclass="sig-paren">(</span><em>message=None</em>, <em>result=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.Message"title="Permalink to this definition">¶</a></dt>
<li><strong>result</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus"title="com.vmware.appliance.networking.dns_client.Servers.MessageStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Servers.MessageStatus</span></code></a>) – result of the test</li>
<emclass="property">class </em><codeclass="descname">MessageStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Servers.MessageStatus</span></code> class Individual test result</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">failure</code><emclass="property"> = MessageStatus(string='failure')</em><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">success</code><emclass="property"> = MessageStatus(string='success')</em><aclass="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>
<emclass="property">class </em><codeclass="descname">TestStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Servers.TestStatus</span></code> class Health indicator</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">green</code><emclass="property"> = TestStatus(string='green')</em><aclass="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>
<codeclass="descname">orange</code><emclass="property"> = TestStatus(string='orange')</em><aclass="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
<codeclass="descname">red</code><emclass="property"> = TestStatus(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.red"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">TestStatusInfo</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add</code><spanclass="sig-paren">(</span><em>server</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">test</code><spanclass="sig-paren">(</span><em>servers</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.Servers.test"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.dns_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.dns_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-networking-interfaces-client-module"></span><h2>com.vmware.appliance.networking.interfaces_client module<aclass="headerlink"href="#module-com.vmware.appliance.networking.interfaces_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.interfaces_client.</code><codeclass="descname">Ipv4</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv4"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4.Mode</span></code></a>) – The Address assignment mode. This attribute was added in vSphere
API 6.7</li>
<li><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Mode.STATIC</span></code></a>.</li>
<li><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The IPv4 CIDR prefix, for example, 24. See
<aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Mode.STATIC</span></code></a>.</li>
<li><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>configurable=None</em>, <em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>configurable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – The specified network interface is configurable or not. This
attribute was added in vSphere API 6.7</li>
<li><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4.Mode</span></code></a>) – The Address assignment mode. This attribute was added in vSphere
API 6.7</li>
<li><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is one of <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Mode.STATIC</span></code></a> or
<li><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The IPv4 CIDR prefix, for example, 24. See
<aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is one of <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Mode.STATIC</span></code></a> or
<li><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is one of <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Mode.STATIC</span></code></a> or
<emclass="property">class </em><codeclass="descname">Mode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv4.Mode</span></code> class defines different IPv4 address assignment modes.
This enumeration was added in vSphere API 6.7</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DHCP</code><emclass="property"> = Mode(string='DHCP')</em><aclass="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
<codeclass="descname">STATIC</code><emclass="property"> = Mode(string='STATIC')</em><aclass="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
<codeclass="descname">UNCONFIGURED</code><emclass="property"> = Mode(string='UNCONFIGURED')</em><aclass="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
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>interface_name</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>interface_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Network interface to query, for example, “nic0”.
The parameter must be an identifier for the resource type:
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>interface_name</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="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
<li><strong>interface_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Network interface to update, for example, “nic0”.
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.interfaces_client.</code><codeclass="descname">Ipv6</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Address</code><spanclass="sig-paren">(</span><em>address=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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</li>
<li><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The IPv6 CIDR prefix, for example, 64. This attribute was added in
<emclass="property">class </em><codeclass="descname">AddressInfo</code><spanclass="sig-paren">(</span><em>origin=None</em>, <em>status=None</em>, <em>address=None</em>, <em>prefix=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>origin</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin"title="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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</li>
<li><strong>status</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status"title="com.vmware.appliance.networking.interfaces_client.Ipv6.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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</li>
<li><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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</li>
<li><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The IPv6 CIDR prefix, for example, 64. This attribute was added in
<emclass="property">class </em><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>dhcp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – An address will be assigned by a DHCP server. This attribute was
added in vSphere API 6.7</li>
<li><strong>autoconf</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – An address will be assigned by Stateless Address Autoconfiguration
(SLAAC). This attribute was added in vSphere API 6.7</li>
<li><strong>addresses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address"title="com.vmware.appliance.networking.interfaces_client.Ipv6.Address"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6.Address</span></code></a>) – The list of addresses to be statically assigned. This attribute was
added in vSphere API 6.7</li>
<li><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em>, <em>configurable=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>dhcp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – DHCP is on. This attribute was added in vSphere API 6.7</li>
<li><strong>autoconf</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Stateless Address Autoconfiguration (SLAAC) is on. This attribute
was added in vSphere API 6.7</li>
<li><strong>addresses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo"title="com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6.AddressInfo</span></code></a>) – List of addresses with their origins and statuses. This attribute
was added in vSphere API 6.7</li>
<li><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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</li>
<li><strong>configurable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is NIC configurable or not. This attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">Origin</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6.Origin</span></code> class defines IPv6 address origin values. This
enumeration was added in vSphere API 6.7</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DHCP</code><emclass="property"> = Origin(string='DHCP')</em><aclass="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
<codeclass="descname">LINKLAYER</code><emclass="property"> = Origin(string='LINKLAYER')</em><aclass="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>
<codeclass="descname">MANUAL</code><emclass="property"> = Origin(string='MANUAL')</em><aclass="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
<codeclass="descname">OTHER</code><emclass="property"> = Origin(string='OTHER')</em><aclass="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>
<codeclass="descname">RANDOM</code><emclass="property"> = Origin(string='RANDOM')</em><aclass="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
<emclass="property">class </em><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6.Status</span></code> class defines IPv6 address status values. See RFC 4293.
This enumeration was added in vSphere API 6.7</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DEPRECATED</code><emclass="property"> = Status(string='DEPRECATED')</em><aclass="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
<codeclass="descname">DUPLICATE</code><emclass="property"> = Status(string='DUPLICATE')</em><aclass="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
<codeclass="descname">INACCESSIBLE</code><emclass="property"> = Status(string='INACCESSIBLE')</em><aclass="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
<codeclass="descname">INVALID</code><emclass="property"> = Status(string='INVALID')</em><aclass="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
<codeclass="descname">OPTIMISTIC</code><emclass="property"> = Status(string='OPTIMISTIC')</em><aclass="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
<codeclass="descname">PREFERRED</code><emclass="property"> = Status(string='PREFERRED')</em><aclass="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>
<codeclass="descname">TENTATIVE</code><emclass="property"> = Status(string='TENTATIVE')</em><aclass="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
<codeclass="descname">UNKNOWN</code><emclass="property"> = Status(string='UNKNOWN')</em><aclass="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
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>interface_name</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>interface_name</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="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
<li><strong>interface_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Network interface to update, for example, “nic0”.
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking.interfaces_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking.interfaces_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
