mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 02:39:59 -05:00
658 lines
54 KiB
HTML
658 lines
54 KiB
HTML
|
|
|||
|
|
|||
|
<!DOCTYPE html>
|
|||
|
<html class="writer-html5" lang="en" >
|
|||
|
<head>
|
|||
|
<meta charset="utf-8" />
|
|||
|
|
|||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
|||
|
<title>com.vmware.vcenter.namespace_management.supervisors.networks package — vSphere Automation SDK for Python. 8.0.0.1 documentation</title>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<!--[if lt IE 9]>
|
|||
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
<![endif]-->
|
|||
|
|
|||
|
|
|||
|
<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 type="text/javascript" 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.vcenter.namespaces package" href="com.vmware.vcenter.namespaces.html" />
|
|||
|
<link rel="prev" title="com.vmware.vcenter.namespace_management.supervisors package" href="com.vmware.vcenter.namespace_management.supervisors.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.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.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="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" class="icon icon-home"></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.namespace_management.html">com.vmware.vcenter.namespace_management package</a> »</li>
|
|||
|
|
|||
|
<li><a href="com.vmware.vcenter.namespace_management.supervisors.html">com.vmware.vcenter.namespace_management.supervisors package</a> »</li>
|
|||
|
|
|||
|
<li>com.vmware.vcenter.namespace_management.supervisors.networks package</li>
|
|||
|
|
|||
|
|
|||
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|||
|
|
|||
|
<a href="_sources/com.vmware.vcenter.namespace_management.supervisors.networks.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.namespace_management.supervisors.networks">
|
|||
|
<span id="com-vmware-vcenter-namespace-management-supervisors-networks-package"></span><h1>com.vmware.vcenter.namespace_management.supervisors.networks package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors.networks" 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.namespace_management.supervisors.networks.management_client">
|
|||
|
<span id="com-vmware-vcenter-namespace-management-supervisors-networks-management-client-module"></span><h2>com.vmware.vcenter.namespace_management.supervisors.networks.management_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors.networks.management_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</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">backing</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">services</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">ip_management</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">floating_ip_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">proxy</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.vcenter.namespace_management.supervisors.networks.management_client.Network" 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">Network</span></code> class represents configuration for a network used to manage the
|
|||
|
Supervisor control plane. vCenter and, if used, NSX Manager and/or external
|
|||
|
Load Balancers, etc. should be reachable on this network.. This class was
|
|||
|
added in vSphere API 8.0.0.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>network</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.network</span></code> is a unique identifier for this network
|
|||
|
which can be referenced later for updates or queries.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
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.namespace_management.Network</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.namespace_management.Network</span></code>.
|
|||
|
If unset, an ID will be generated.</p></li>
|
|||
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkBacking</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.backing</span></code> specifies the network backing to use as the
|
|||
|
uplink to the management network.. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>services</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.Services" title="com.vmware.vcenter.namespace_management.networks_client.Services"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.Services</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.services</span></code> specifies which network services are
|
|||
|
configured on this network. These network services are expected to
|
|||
|
be accessible via the associated distributed virtual port group or
|
|||
|
distributed virtual switch.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
If unset, network services may be automatically configured. If you
|
|||
|
want to disable any configuration of network services, explicitly
|
|||
|
set this class to empty.</p></li>
|
|||
|
<li><p><strong>ip_management</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.IPManagement" title="com.vmware.vcenter.namespace_management.networks_client.IPManagement"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.IPManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.ip_management</span></code> describes how IP addressing is
|
|||
|
configured on this network.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
If unset, this network becomes a DHCP network. Your DHCP server
|
|||
|
must support client identifiers to successfully enable a
|
|||
|
Supervisor.</p></li>
|
|||
|
<li><p><strong>floating_ip_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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.floating_ip_address</span></code> is an IP address that provides
|
|||
|
a stable endpoint to the control plane. This address if specified
|
|||
|
must be an unused statically allocated IP address on the management
|
|||
|
network.. This attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None and the management network is a static network, this
|
|||
|
address should be allocated in a static IP configuration which
|
|||
|
occurs when
|
|||
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.IPManagement.dhcp_enabled</span></code>
|
|||
|
is set to false. If None and the management network is a DHCP
|
|||
|
network, The Supervisor will attempt to use the DHCP server to
|
|||
|
allocate this address. You should ensure the DHCP server is
|
|||
|
configured to persist IP addresses indefinitely using client
|
|||
|
identifiers if this configuration is used.</p></li>
|
|||
|
<li><p><strong>proxy</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Proxy configuration will be applied to the Supervisor. The proxy
|
|||
|
should be reachable from the management network and will be used
|
|||
|
for image pulling and container traffic exiting out of the
|
|||
|
Supervisor.. This attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None the settings will be inherited from the vCenter settings if
|
|||
|
available.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">NetworkBacking</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backing</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">network</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.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking" 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>A <code class="docutils literal notranslate"><span class="pre">NetworkBacking</span></code> enumerates the possible options for uplinking to a
|
|||
|
Supervisor management network.. This class was added in vSphere API
|
|||
|
8.0.0.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>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkBackingEnum</span></code></a>) – Selects the backing used for a management network.. This attribute
|
|||
|
was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The Managed Object ID of the Network object.. This attribute was
|
|||
|
added in vSphere API 8.0.0.1.
|
|||
|
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">Network</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">Network</span></code>.
|
|||
|
This attribute is optional and it is only relevant when the value
|
|||
|
of <code class="docutils literal notranslate"><span class="pre">backing</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NetworkBackingEnum.NETWORK</span></code></a>.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">NetworkBackingEnum</span></code><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.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum" 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">NetworkBackingEnum</span></code> enumerates types of network backings supported by
|
|||
|
the Supervisor for the management network.. This enumeration was added in
|
|||
|
vSphere API 8.0.0.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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkBackingEnum</span></code></a> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK">
|
|||
|
<code class="sig-name descname"><span class="pre">NETWORK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkBackingEnum(string='NETWORK')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Indicates a virtual infrastructure management Network. It may include items
|
|||
|
like opaque networks or Distributed Virtual Port Groups.. This class
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">ProxyConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proxy_settings_source</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">https_proxy_config</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">http_proxy_config</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">no_proxy_config</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">tls_root_ca_bundle</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.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration" 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">ProxyConfiguration</span></code> class defines proxy configuration to be used by
|
|||
|
the Supervisor.. This class was added in vSphere API 8.0.0.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>proxy_settings_source</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxySettingsSource</span></code></a>) – <p>The source of the proxy settings.</p>
|
|||
|
<p>If <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.VC_INHERITED" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.VC_INHERITED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.VC_INHERITED</span></code></a> or
|
|||
|
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.NONE" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.NONE</span></code></a> is specified, then the other
|
|||
|
configuration in <code class="docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code> will be ignored.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p>
|
|||
|
</p></li>
|
|||
|
<li><p><strong>https_proxy_config</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>) – <p>HTTPS proxy configuration. Examples:</p>
|
|||
|
<ul>
|
|||
|
<li><p><a class="reference external" href="http://username:password">http://username:password</a>\@proxy.vmware.com:8080</p></li>
|
|||
|
<li><p><a class="reference external" href="https://proxy.vmware.com:4443">https://proxy.vmware.com:4443</a></p></li>
|
|||
|
</ul>
|
|||
|
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
|
|||
|
is used for the source, otherwise this will be ignored.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None no HTTPS proxy will be used.</p>
|
|||
|
</p></li>
|
|||
|
<li><p><strong>http_proxy_config</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>) – <p>HTTP proxy configuration. Examples:</p>
|
|||
|
<ul>
|
|||
|
<li><p><a class="reference external" href="http://username:password">http://username:password</a>\@proxy.vmware.com:8080</p></li>
|
|||
|
<li><p><a class="reference external" href="https://proxy.vmware.com:4443">https://proxy.vmware.com:4443</a></p></li>
|
|||
|
</ul>
|
|||
|
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
|
|||
|
is used for the source, otherwise this will be ignored.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None no HTTP proxy will be used.</p>
|
|||
|
</p></li>
|
|||
|
<li><p><strong>no_proxy_config</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>) – <p>List of addresses that should be accessed directly.</p>
|
|||
|
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
|
|||
|
is used for the source, otherwise this will be ignored.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None there won’t be any excluded addresses.</p>
|
|||
|
</p></li>
|
|||
|
<li><p><strong>tls_root_ca_bundle</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>) – <p>Proxy TLS root CA bundle which will be used to verify the proxy’s
|
|||
|
certificates. Every certificate in the bundle is expected to be in
|
|||
|
PEM format.</p>
|
|||
|
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
|
|||
|
is used for the source, otherwise this will be ignored.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
If None only the vCenter certificates applied in VECS (VMware
|
|||
|
Endpoint Certificate Store) will be used.</p>
|
|||
|
</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">ProxySettingsSource</span></code><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.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource" 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 settings can be inherited from the vCenter settings, so the Supervisor
|
|||
|
settings will be synced. The settings can be applied directly on the
|
|||
|
Supervisor level, or the Supervisor can be configured not to use a proxy..
|
|||
|
This enumeration was added in vSphere API 8.0.0.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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxySettingsSource</span></code></a> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED">
|
|||
|
<code class="sig-name descname"><span class="pre">CLUSTER_CONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='CLUSTER_CONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Proxy settings will be configured at the Supervisor level. This class
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.NONE">
|
|||
|
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.NONE" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>No proxy settings will be applied to the Supervisor. This class attribute
|
|||
|
was added in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.VC_INHERITED">
|
|||
|
<code class="sig-name descname"><span class="pre">VC_INHERITED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='VC_INHERITED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.VC_INHERITED" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Proxy settings will be inherited from the vCenter settings. vCenter and
|
|||
|
Supervisor settings will be kept in sync.. This class attribute was added
|
|||
|
in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.StubFactory">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><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.vcenter.namespace_management.supervisors.networks.management_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 class="section" id="module-com.vmware.vcenter.namespace_management.supervisors.networks.workload_client">
|
|||
|
<span id="com-vmware-vcenter-namespace-management-supervisors-networks-workload-client-module"></span><h2>com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors.networks.workload_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</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">network_type</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">nsx</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">vsphere</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">services</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">ip_management</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.vcenter.namespace_management.supervisors.networks.workload_client.Network" 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">Network</span></code> class represents configuration for a network running workloads
|
|||
|
on a Supervisor.. This class was added in vSphere API 8.0.0.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>network</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.network</span></code> is a unique identifier for this network
|
|||
|
which can be referenced later for updates or queries.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
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.namespace_management.Network</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.namespace_management.Network</span></code>.
|
|||
|
If unset, an ID will be generated.</p></li>
|
|||
|
<li><p><strong>network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.network_type</span></code> describes the type of network.. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>nsx</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">NsxNetwork</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.nsx</span></code> specifies network configuration that is
|
|||
|
specific to NSX-T networks.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
This attribute is optional and it is only relevant when the value
|
|||
|
of <code class="docutils literal notranslate"><span class="pre">networkType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.NSXT" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.NSXT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NetworkType.NSXT</span></code></a>.</p></li>
|
|||
|
<li><p><strong>vsphere</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">VSphereNetwork</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.vsphere</span></code> specifies network configuration that is
|
|||
|
specific to vSphere networks.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
This attribute is optional and it is only relevant when the value
|
|||
|
of <code class="docutils literal notranslate"><span class="pre">networkType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.VSPHERE" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.VSPHERE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NetworkType.VSPHERE</span></code></a>.</p></li>
|
|||
|
<li><p><strong>services</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.Services" title="com.vmware.vcenter.namespace_management.networks_client.Services"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.Services</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.services</span></code> specifies which network services are
|
|||
|
configured on this network. These network services are expected to
|
|||
|
be accessible via the associated distributed virtual port group or
|
|||
|
distributed virtual switch.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
If unset, network services may be automatically configured. If you
|
|||
|
want to disable any configuration of network services, explicitly
|
|||
|
set this class to empty.</p></li>
|
|||
|
<li><p><strong>ip_management</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.IPManagement" title="com.vmware.vcenter.namespace_management.networks_client.IPManagement"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.IPManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.ip_management</span></code> describes how IP addressing is
|
|||
|
configured on this network.. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.
|
|||
|
If unset, this network becomes a DHCP network. Your DHCP server
|
|||
|
must support client identifiers to successfully enable a
|
|||
|
Supervisor.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.</span></code><code class="sig-name descname"><span class="pre">NetworkType</span></code><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.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType" 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">NetworkType</span></code> enumerates types of networks supported by the Supervisor
|
|||
|
for workloads.. This enumeration was added in vSphere API 8.0.0.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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.NSXT">
|
|||
|
<code class="sig-name descname"><span class="pre">NSXT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkType(string='NSXT')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.NSXT" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Indicates an NSX-T backed network.. This class attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.VSPHERE">
|
|||
|
<code class="sig-name descname"><span class="pre">VSPHERE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkType(string='VSPHERE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.VSPHERE" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Indicates vSphere Networking.. This class attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.</span></code><code class="sig-name descname"><span class="pre">NsxNetwork</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dvs</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">namespace_subnet_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.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork" 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">NsxNetwork</span></code> specifies network backing configuration that is specific to
|
|||
|
the workload network.. This class was added in vSphere API 8.0.0.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>dvs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NsxNetwork.dvs</span></code> is the Managed Object ID of a vSphere
|
|||
|
Distributed Virtual Switch. You can use it to connect to an NSX-T
|
|||
|
Network.. This attribute was added in vSphere API 8.0.0.1.
|
|||
|
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">vSphereDistributedSwitch</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">vSphereDistributedSwitch</span></code>.</p></li>
|
|||
|
<li><p><strong>namespace_subnet_prefix</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NsxNetwork.namespace_subnet_prefix</span></code> indicates the size of
|
|||
|
the subnet reserved for namespace segments.. This attribute was
|
|||
|
added in vSphere API 8.0.0.1.
|
|||
|
Defaults to /28.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.StubFactory">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><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.vcenter.namespace_management.supervisors.networks.workload_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>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt id="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork">
|
|||
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.</span></code><code class="sig-name descname"><span class="pre">VSphereNetwork</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dvpg</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.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork" 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">VSphereNetwork</span></code> specifies workload network configuration that is
|
|||
|
specific to vSphere networks.. This class was added in vSphere API 8.0.0.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"><p><strong>dvpg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">VSphereNetwork.dvpg</span></code> is the Managed Object ID of a vSphere
|
|||
|
Distributed Virtual Port Group. You can use it to connect to a
|
|||
|
vSphere Network.. This attribute was added in vSphere API 8.0.0.1.
|
|||
|
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">vSphereDistributedPortGroup</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">vSphereDistributedPortGroup</span></code>.</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.namespaces.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespaces package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
<a href="com.vmware.vcenter.namespace_management.supervisors.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.namespace_management.supervisors package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
</div>
|
|||
|
|
|||
|
<hr/>
|
|||
|
|
|||
|
<div role="contentinfo">
|
|||
|
<p>
|
|||
|
© Copyright 2022, 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 type="text/javascript">
|
|||
|
jQuery(function () {
|
|||
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
});
|
|||
|
</script>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</body>
|
|||
|
</html>
|