mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
644 lines
41 KiB
HTML
644 lines
41 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vcenter.vm.guest package — vSphere Automation SDK for Python. 7.0.0.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" 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/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vcenter.vm.hardware package" href="com.vmware.vcenter.vm.hardware.html" />
|
||
<link rel="prev" title="com.vmware.vcenter.vm package" href="com.vmware.vcenter.vm.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">
|
||
7.0.0.1
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.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="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a> »</li>
|
||
|
||
<li>com.vmware.vcenter.vm.guest package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vcenter.vm.guest.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-com.vmware.vcenter.vm.guest">
|
||
<span id="com-vmware-vcenter-vm-guest-package"></span><h1>com.vmware.vcenter.vm.guest package<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.vm.guest.networking_client">
|
||
<span id="com-vmware-vcenter-vm-guest-networking-client-module"></span><h2>com.vmware.vcenter.vm.guest.networking_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest.networking_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest.networking_client</span></code> module provides classes
|
||
for dealing with the guest operating system networking.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest.networking_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Interfaces</span></code> class provides methods for retrieving guest operating
|
||
system network interface information. This class was added in vSphere API
|
||
7.0.0.</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="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">dns_values=None</em>, <em class="sig-param">mac_address=None</em>, <em class="sig-param">dns=None</em>, <em class="sig-param">ip=None</em>, <em class="sig-param">wins_servers=None</em>, <em class="sig-param">nic=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.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">Interfaces.Info</span></code> class describes a virtual network adapter
|
||
configured in the guest operating system. This class was added in vSphere
|
||
API 7.0.0.</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>dns_values</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DnsAssignedValues" title="com.vmware.vcenter.vm.guest_client.DnsAssignedValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DnsAssignedValues</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client DNS values. Data assigned by DNS. This attribute was added
|
||
in vSphere API 7.0.0.
|
||
If None no DNS assigned value exists.</p></li>
|
||
<li><p><strong>mac_address</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>) – MAC address of the adapter. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None then not supported by the Guest OS.</p></li>
|
||
<li><p><strong>dns</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DnsConfigInfo" title="com.vmware.vcenter.vm.guest_client.DnsConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DnsConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS configuration of the adapter. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.Networking.Info.dns</span></code> for
|
||
system wide settings. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None then not assigned by the Guest OS.</p></li>
|
||
<li><p><strong>ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP configuration settings of the adapter. This attribute was added
|
||
in vSphere API 7.0.0.
|
||
If None then not supported by the Guest OS.</p></li>
|
||
<li><p><strong>wins_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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The IP addresses of any WINS name servers for the adapter. This
|
||
attribute was added in vSphere API 7.0.0.
|
||
If None then not supported by the Guest OS.</p></li>
|
||
<li><p><strong>nic</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>) – Link to the corresponding virtual device. This attribute was added
|
||
in vSphere API 7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods return a
|
||
value of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.
|
||
If None then the interface is not backed by a virtual device.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo">
|
||
<em class="property">class </em><code class="sig-name descname">IpAddressInfo</code><span class="sig-paren">(</span><em class="sig-param">ip_address=None</em>, <em class="sig-param">prefix_length=None</em>, <em class="sig-param">origin=None</em>, <em class="sig-param">state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo" 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">Interfaces.IpAddressInfo</span></code> class describes a specific IP Address.
|
||
This class was added in vSphere API 7.0.0.</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>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPv4 address is specified using dotted decimal notation. For
|
||
example, “192.0.2.1”. IPv6 addresses are 128-bit addresses
|
||
specified using eight fields of up to four hexadecimal digits. A
|
||
colon separates each field (:). For example,
|
||
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
||
the symbol ‘::’ to represent multiple 16-bit groups of contiguous
|
||
0’s only once in an address as described in RFC 2373. This
|
||
attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Denotes the length of a generic Internet network address prefix.
|
||
Prefix length: the valid range of values is 0-32 for IPv4, and
|
||
0-128 for IPv6. A value of n corresponds to an IP address mask that
|
||
has n contiguous 1-bits from the most significant bit (MSB), with
|
||
all other bits set to 0. A value of zero is valid only if the
|
||
calling context defines it. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>origin</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressOrigin</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – How this address was configured. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
If None the data was not available.</p></li>
|
||
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressStatus</span></code></a>) – The state of this ipAddress. This attribute was added in vSphere
|
||
API 7.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin">
|
||
<em class="property">class </em><code class="sig-name descname">IpAddressOrigin</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin" 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">Interfaces.IpAddressOrigin</span></code> class specifies how an IP address was
|
||
obtained for an interface. See RFC 4293 IpAddressOriginTC. This enumeration
|
||
was added in vSphere API 7.0.0.</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">IpAddressOrigin</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.DHCP">
|
||
<code class="sig-name descname">DHCP</code><em class="property"> = IpAddressOrigin(string='DHCP')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.DHCP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The address is configured through dhcp. This class attribute was added in
|
||
vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.LINKLAYER">
|
||
<code class="sig-name descname">LINKLAYER</code><em class="property"> = IpAddressOrigin(string='LINKLAYER')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.LINKLAYER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The address is obtained through stateless autoconfiguration (autoconf). See
|
||
RFC 4862, IPv6 Stateless Address Autoconfiguration. This class attribute
|
||
was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.MANUAL">
|
||
<code class="sig-name descname">MANUAL</code><em class="property"> = IpAddressOrigin(string='MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The address is configured manually. This class attribute was added in
|
||
vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.OTHER">
|
||
<code class="sig-name descname">OTHER</code><em class="property"> = IpAddressOrigin(string='OTHER')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.OTHER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Any other type of address configuration other than the below mentioned ones
|
||
will fall under this category. For e.g., automatic address configuration
|
||
for the link local address falls under this type. This class attribute was
|
||
added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.RANDOM">
|
||
<code class="sig-name descname">RANDOM</code><em class="property"> = IpAddressOrigin(string='RANDOM')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin.RANDOM" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The address is chosen by the system at random e.g., an IPv4 address within
|
||
169.254/16, or an RFC 3041 privacy address. This class attribute was added
|
||
in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus">
|
||
<em class="property">class </em><code class="sig-name descname">IpAddressStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus" 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">Interfaces.IpAddressStatus</span></code> class defines the present status of an
|
||
address on an interface. See RFC 4293 IpAddressStatusTC. This enumeration
|
||
was added in vSphere API 7.0.0.</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">IpAddressStatus</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DEPRECATED">
|
||
<code class="sig-name descname">DEPRECATED</code><em class="property"> = IpAddressStatus(string='DEPRECATED')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that this is a valid but deprecated address that should no longer
|
||
be used as a source address. This class attribute was added in vSphere API
|
||
7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DUPLICATE">
|
||
<code class="sig-name descname">DUPLICATE</code><em class="property"> = IpAddressStatus(string='DUPLICATE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.DUPLICATE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the address has been determined to be non-unique on the link,
|
||
this address will not be reachable. This class attribute was added in
|
||
vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INACCESSIBLE">
|
||
<code class="sig-name descname">INACCESSIBLE</code><em class="property"> = IpAddressStatus(string='INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the address is not accessible because interface is not
|
||
operational. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INVALID">
|
||
<code class="sig-name descname">INVALID</code><em class="property"> = IpAddressStatus(string='INVALID')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.INVALID" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that this isn’t a valid address. This class attribute was added
|
||
in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.PREFERRED">
|
||
<code class="sig-name descname">PREFERRED</code><em class="property"> = IpAddressStatus(string='PREFERRED')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.PREFERRED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that this is a valid address. This class attribute was added in
|
||
vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.TENTATIVE">
|
||
<code class="sig-name descname">TENTATIVE</code><em class="property"> = IpAddressStatus(string='TENTATIVE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.TENTATIVE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the uniqueness of the address on the link is presently being
|
||
verified. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.UNKNOWN">
|
||
<code class="sig-name descname">UNKNOWN</code><em class="property"> = IpAddressStatus(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the status cannot be determined. This class attribute was
|
||
added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo">
|
||
<em class="property">class </em><code class="sig-name descname">IpConfigInfo</code><span class="sig-paren">(</span><em class="sig-param">ip_addresses=None</em>, <em class="sig-param">dhcp=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpConfigInfo" 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">Interfaces.IpConfigInfo</span></code> class describes the protocol version
|
||
independent address reporting data object for network interfaces. This
|
||
class was added in vSphere API 7.0.0.</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>ip_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.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.IpAddressInfo</span></code></a>) – IP addresses configured on the interface. This attribute was added
|
||
in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>dhcp</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.guest_client.DhcpConfigInfo" title="com.vmware.vcenter.vm.guest_client.DhcpConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client.DhcpConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client side DHCP for an interface. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
If None the IP was not configured by DHCP.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about the networking interfaces in the guest
|
||
operating system. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interfaces.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the interfaces configured in the guest operating
|
||
system. Interfaces are ordered in a guest operating system specific
|
||
determined order.</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>
|
||
if the system reports an error while responding to the request.</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>
|
||
if the virtual machine 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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if VMware Tools is not running.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest.networking_client.</code><code class="sig-name descname">Routes</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes" 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">Routes</span></code> class provides methods for retrieving guest operating system
|
||
network routing information. This class was added in vSphere API 7.0.0.</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="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">network=None</em>, <em class="sig-param">prefix_length=None</em>, <em class="sig-param">gateway_address=None</em>, <em class="sig-param">interface_index=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.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">Routes.Info</span></code> class describes an individual host, network or default
|
||
destination network reachable through a gateway. This class was added in
|
||
vSphere API 7.0.0.</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>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP Address of the destination IP network. IPv4 address is specified
|
||
using dotted decimal notation. For example, “192.0.2.1”. IPv6
|
||
addresses are 128-bit specified using as eight fields of up to four
|
||
hexadecimal digits. A colon separates each field (:). For example,
|
||
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
||
symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s
|
||
only once in an address as described in RFC 2373. This attribute
|
||
was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The prefix length. For IPv4 the value range is 0-32. For IPv6
|
||
prefixLength is a decimal value range 0-128. The property
|
||
represents the number of contiguous, higher-order bits of the
|
||
address that make up the network portion of the IP address. This
|
||
attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>gateway_address</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>) – Where to send the packets for this route. Unicast IP Address of the
|
||
next hop router. IPv4 address is specified using dotted decimal
|
||
notation. For example, “192.0.2.1”. IPv6 addresses are 128-bit
|
||
specified using as eight fields of up to four hexadecimal digits. A
|
||
colon separates each field (:). For example,
|
||
2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of
|
||
symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s
|
||
only once in an address as described in RFC 2373. This attribute
|
||
was added in vSphere API 7.0.0.
|
||
If None no gateway is set for the route.</p></li>
|
||
<li><p><strong>interface_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The network interface associated with this route. This is an index
|
||
into the result of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Interfaces.list" title="com.vmware.vcenter.vm.guest.networking_client.Interfaces.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.list()</span></code></a> The index refers to the
|
||
relative position of an element in a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>. For example, an
|
||
index of 0 refers to the first element in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> while
|
||
an index of 1 refers to the second element. This attribute was
|
||
added in vSphere API 7.0.0.
|
||
If None the route is not associated with a network interface.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.Routes.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about network routing in the guest operating
|
||
system. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.list" title="com.vmware.vcenter.vm.guest.networking_client.Routes.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest.networking_client.Routes.Info" title="com.vmware.vcenter.vm.guest.networking_client.Routes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Routes.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the network routes configured in the guest
|
||
operating system.</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>
|
||
if the system reports an error while responding to the request.</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>
|
||
if the virtual machine 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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if VMware Tools is not running.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm.guest.networking_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest.networking_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest.networking_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<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>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vcenter.vm.hardware.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm.hardware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.vcenter.vm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2020, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |