Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code
0c2294f46c
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.namespace_management.networks.html
bhagatp10 44eb68437b
Updated VC docs for v8.0.3.0 (#424) 
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>

Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 17:44:27 +05:30

837 lines
88 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.namespace_management.networks package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.namespace_management.networks.nsx package" href="com.vmware.vcenter.namespace_management.networks.nsx.html" />
<link rel="prev" title="com.vmware.vcenter.namespace_management package" href="com.vmware.vcenter.namespace_management.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.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_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.snapservice_client">com.vmware.snapservice_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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.namespace_management.html">com.vmware.vcenter.namespace_management package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.namespace_management.networks package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.namespace_management.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">
<section id="module-com.vmware.vcenter.namespace_management.networks">
<span id="com-vmware-vcenter-namespace-management-networks-package"></span><h1>com.vmware.vcenter.namespace_management.networks package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html">com.vmware.vcenter.namespace_management.networks.nsx package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#module-com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client">com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility"><code class="docutils literal notranslate"><span class="pre">Compatibility</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility.Summary"><code class="docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility.check"><code class="docutils literal notranslate"><span class="pre">Compatibility.check()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#module-com.vmware.vcenter.namespace_management.networks.nsx.edges_client">com.vmware.vcenter.namespace_management.networks.nsx.edges_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility"><code class="docutils literal notranslate"><span class="pre">Compatibility</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.Summary"><code class="docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.check"><code class="docutils literal notranslate"><span class="pre">Compatibility.check()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.vcenter.namespace_management.networks.edges_client">
<span id="com-vmware-vcenter-namespace-management-networks-edges-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks.edges_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.edges_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client</span></code> module
provides classes and classes to manage NSX Edge resources.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.Edge">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">Edge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</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">load_balancer_address_ranges</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">haproxy</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">nsx_advanced</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">provider</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.networks.edges_client.Edge" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Edge</span></code> class contains configuration for network traffic entering and
exiting 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</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">Edge.id</span></code> is a unique identifier that can be referenced for
updates. 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.edge.Edge</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.edge.Edge</span></code>.
If unset, an ID will be automatically generated.</p></li>
<li><p><strong>load_balancer_address_ranges</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.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.IPRange" title="com.vmware.vcenter.namespace_management.networks_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.IPRange</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">Edge.load_balancer_address_ranges</span></code> defines the list of
addresses that a load balancer can consume to publish Kubernetes
services. This range must contain at least one IP address unless
the NSX Advanced provider is selected. It is recommended to supply
a large enough range to support load balancers requested for pods
in the control plane and Tanzu Clusters. . This attribute was added
in vSphere API 8.0.0.1.
This field must be set if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Edge.provider</span></code> is not an NSX
Advanced Load Balancer . This field is required if you want to load
balance traffic on a DHCP Workload Network.</p></li>
<li><p><strong>haproxy</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.HAProxyConfig" title="com.vmware.vcenter.namespace_management.networks.edges_client.HAProxyConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">HAProxyConfig</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Edge.haproxy</span></code> defines configuration for the HAProxy Load
Balancer. 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">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.HAPROXY</span></code></a>.</p></li>
<li><p><strong>nsx</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXConfig" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">NSXConfig</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Edge.nsx</span></code> defines configuration for the NSX Load Balancer.
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">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.NSX</span></code></a>.</p></li>
<li><p><strong>nsx_advanced</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">NSXAdvancedLBConfig</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Edge.nsx_advanced</span></code> defines configuration for the NSX
Advanced Load Balancer and Ingress Software. 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">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.NSX_ADVANCED</span></code></a>.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeProvider</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">Edge.provider</span></code> specifies the vendor providing edge services.
This attribute was added in vSphere API 8.0.0.1.
A provider is required to enable edge services for a cluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">EdgeProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">EdgeProvider</span></code> describes the supported available edge services. An NSX
edge are used on NSX-T networks, but “Advanced NSX”, HAProxy, and vSphere
Foundation edges are used on VDS networks. 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="bora/vspherevmodl2/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<span class="colon">:</span></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.networks.edges_client.EdgeProvider" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeProvider</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY">
<span class="sig-name descname"><span class="pre">HAPROXY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">EdgeProvider(string='HAPROXY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.HAPROXY</span></code></a> is an HAProxy load balancer fronted by the
Data Plane API. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX">
<span class="sig-name descname"><span class="pre">NSX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">EdgeProvider(string='NSX')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.NSX</span></code></a> specifies NSX-T managed edge services. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED">
<span class="sig-name descname"><span class="pre">NSX_ADVANCED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">EdgeProvider(string='NSX_ADVANCED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED" title="com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EdgeProvider.NSX_ADVANCED</span></code></a> specifies the NSX Advanced Load Balancer
and Ingress. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.HAProxyConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">HAProxyConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</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">password</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">certificate_authority_chain</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.networks.edges_client.HAProxyConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">HAProxyConfig</span></code> class describes configuration for the HAProxy Load
Balancer. 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</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.namespace_management.networks.edges_client.Server" title="com.vmware.vcenter.namespace_management.networks.edges_client.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">Server</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">HAProxyConfig.servers</span></code> is a list of the addresses for the
data plane API servers used to configure Virtual Servers. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>username</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">HAProxyConfig.username</span></code> is used by the HAProxy Kubernetes
Operator to program the HAProxy Controller. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>password</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">HAProxyConfig.password</span></code> secures the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">HAProxyConfig.username</span></code>. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>certificate_authority_chain</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">HAProxyConfig.certificate_authority_chain</span></code> contains
PEM-encoded CA chain which is used to verify x509 certificates
received from the server. This attribute was added in vSphere API
8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">LoadBalancerSize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancerSize</span></code> class enumerates load balancer sizes supported by
NSX. 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="bora/vspherevmodl2/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<span class="colon">:</span></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.networks.edges_client.LoadBalancerSize" title="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancerSize</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.LARGE">
<span class="sig-name descname"><span class="pre">LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">LoadBalancerSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.LARGE" title="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.LARGE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancerSize.LARGE</span></code></a> is a load balancer that hosts up to 1000
virtual servers. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.MEDIUM">
<span class="sig-name descname"><span class="pre">MEDIUM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">LoadBalancerSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.MEDIUM" title="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.MEDIUM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancerSize.MEDIUM</span></code></a> is a load balancer that hosts up to 100
virtual servers. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.SMALL">
<span class="sig-name descname"><span class="pre">SMALL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">LoadBalancerSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.SMALL" title="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.SMALL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancerSize.SMALL</span></code></a> is a load balancer that hosts up to 20
virtual servers. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">NSXAdvancedLBConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</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">username</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">password</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">certificate_authority_chain</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">cloud_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">NSXAdvancedLBConfig</span></code> class is used to describe the NSX Advanced Load
Balancer configuration. 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>server</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.Server" title="com.vmware.vcenter.namespace_management.networks.edges_client.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">Server</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXAdvancedLBConfig.server</span></code> is the address for the Avi
Controller, used to configure Virtual Servers. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>username</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">NSXAdvancedLBConfig.username</span></code> is used by the Avi Kubernetes
Operator to program the Avi Controller. This attribute was added in
vSphere API 8.0.0.1.</p></li>
<li><p><strong>password</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">NSXAdvancedLBConfig.password</span></code> is the password for the
username. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>certificate_authority_chain</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">NSXAdvancedLBConfig.certificate_authority_chain</span></code> contains
PEM-encoded CA chain which is used to verify x509 certificates
received from the server. This attribute was added in vSphere API
8.0.0.1.</p></li>
<li><p><strong>cloud_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The cloud name for the Avi Controller. This attribute was added in
vSphere API 8.0.2.00300.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if custom cloud name is configured for this Avi
Controller. If None, it defaults to “Default-Cloud”.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.NSXConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">NSXConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_cluster_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_ingress_tls_certificate</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">routing_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_ip_ranges</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">t0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancer_size</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.networks.edges_client.NSXConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">NSXConfig</span></code> class describes the configuration for NSX-T Edge services.
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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>edge_cluster_id</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">NSXConfig.edge_cluster_id</span></code> defines the NSX Edge Cluster to
be used for Kubernetes Services of type LoadBalancer, Kubernetes
Ingresses, and NSX SNAT. This attribute was added in vSphere API
8.0.0.1.
Defaults to a the edge cluster created earliest.</p></li>
<li><p><strong>default_ingress_tls_certificate</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">NSXConfig.default_ingress_tls_certificate</span></code> defines a default
certificate that is served on Ingress services, when another
certificate is not presented. This configuration applies to all
namespaces by default. This attribute was added in vSphere API
8.0.0.1.
If unset, there will be no certificate served on Ingress.</p></li>
<li><p><strong>routing_mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">NSXRoutingMode</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">NSXConfig.routing_mode</span></code> enables the network topology in
either NAT mode or Routed Mode. Enabling routed mode will result in
all the workloads i.e vSphere PODs, VMs and Tanzu clusters Node IPs
to be directly accessible from networks beyond the Tier-0 router.
Once a namespace mode is applied, it cannot be changed. This
attribute was added in vSphere API 8.0.0.1.
The default setting is NAT mode.</p></li>
<li><p><strong>egress_ip_ranges</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.namespace_management.html#com.vmware.vcenter.namespace_management.networks_client.IPRange" title="com.vmware.vcenter.namespace_management.networks_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.IPRange</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXConfig.egress_ip_ranges</span></code> lists the IP Ranges from which
NSX assigns IP addresses used for performing SNAT from container
IPs to external IPs. These ranges must not overlap with other IP
ranges on this network. This attribute was added in vSphere API
8.0.0.1.
If this range is empty, network traffic will not be able to exit
the cluster.</p></li>
<li><p><strong>t0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXConfig.t0_gateway</span></code> specifies the default Tier-0 gateway
ID for the namespaces configuration. 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">NSXTier0Gateway</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">NSXTier0Gateway</span></code>.
If unset, the default Tier-0 gateway from the edge cluster is used.</p></li>
<li><p><strong>load_balancer_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize" title="com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancerSize</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">NSXConfig.load_balancer_size</span></code> describes the load balancer
sizing options available. Larger sizes support more active virtual
servers, but consume more resources. This attribute was added in
vSphere API 8.0.0.1.
If unset, the size defaults to small.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">NSXRoutingMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">NSXRoutingMode</span></code> enum defines an enumeration of available routing modes.
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="bora/vspherevmodl2/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<span class="colon">:</span></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.networks.edges_client.NSXRoutingMode" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">NSXRoutingMode</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.NAT">
<span class="sig-name descname"><span class="pre">NAT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">NSXRoutingMode(string='NAT')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.NAT" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.NAT" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.NAT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXRoutingMode.NAT</span></code></a> uses network address translation and the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXConfig.egress_ip_ranges</span></code> to route traffic out of the cluster.
This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.ROUTED">
<span class="sig-name descname"><span class="pre">ROUTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">NSXRoutingMode(string='ROUTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.ROUTED" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.ROUTED" title="com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.ROUTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NSXRoutingMode.ROUTED</span></code></a> configures NSX-T to route directly to Pods
cluster IP addresses. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.Server">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">Server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</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">port</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.networks.edges_client.Server" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>A <code class="docutils literal notranslate"><span class="pre">Server</span></code> class represents an endpoint used to configure load balancers.
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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</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">Server.host</span></code> specifies a the management hostname or IPv4
address for a load balancer. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Server.port</span></code> specifies a management port used to access a
load balancer. This attribute was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.edges_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.edges_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.namespace_management.networks.nsx_client">
<span id="com-vmware-vcenter-namespace-management-networks-nsx-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks.nsx_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.nsx_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx_client</span></code> module
provides classes and classes for managing nsx resources.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx_client.</span></span><span class="sig-name descname"><span class="pre">DistributedSwitches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitches</span></code> class provides methods to get the basic
information of Distributed Switches. This class was added in vSphere API
8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible</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">zones</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.networks.nsx_client.DistributedSwitches.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code> class contains attributes used to
filter the results when listing Distributed Switches (see
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">DistributedSwitches.list()</span></code></a>). 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compatibility criteria. If true, only Distributed Switches
compatible with the vSphere Namespaces will be returned. If false,
only Distributed Switches incompatible with the vSphere Namespaces
will be returned. This attribute was added in vSphere API 8.0.0.1.
If None, both compatible and incompatible Distributed Switches will
be returned.</p></li>
<li><p><strong>zones</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>) – Zone compatibility criteria. If zones are specified, the common
distributed switches across the given zones will returned. A
distributed switch is considered common if it is present in all of
the vSphere clusters in a given zone. 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 contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.consumption_domains.Zone</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.consumption_domains.Zone</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">distributed_switch</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">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitches.Summary</span></code> class contains the basic information
about a Distributed Switch. 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the switch. The value of this field refers to the
UUID of a vim.DistributedVirtualSwitch. 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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable identifier of the switch. This attribute was added
in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</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.networks.nsx_client.DistributedSwitches.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns basic information of the Distributed Switches matching the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a>. This method was added in
vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching Distributed Switches for which
information should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a> with all attributes None
which means all Distributed Switches will be returned.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.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.namespace_management.networks.nsx_client.DistributedSwitches.Summary" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of Distributed Switches summaries matching the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if one or more fields of the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a> is incorrect.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx_client.</span></span><span class="sig-name descname"><span class="pre">Edges</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Edges</span></code> class provides methods to retrieve the basic information for
NSX Edges. This class was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible</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">distributed_switch</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.networks.nsx_client.Edges.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Edges.FilterSpec</span></code> class contains attributes used to filter the
results when listing Edges (see <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.list" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Edges.list()</span></code></a>). 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compatibility criteria. If true, only Edges which are compatible
with vSphere Namespaces will be returned. If false, only Edges
incompatible with vSphere Namespaces will be returned. This
attribute was added in vSphere API 8.0.0.1.
If None, both compatible and incompatible Edges will be returned.</p></li>
<li><p><strong>distributed_switch</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>) – Distributed switch UUID criteria. If distributed switches
identifiers are specified, they will be used to filter the Edges.
To obtain the available distributed switch UUIDs, use:
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list" title="com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">DistributedSwitches.list()</span></code></a>. 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 contain identifiers 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 contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_cluster</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">name</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">path</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.networks.nsx_client.Edges.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Edges.Summary</span></code> class contains the basic information about an Edge.
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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>edge_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Edge. 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">NSXEdgeCluster</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">NSXEdgeCluster</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable identifier of the Edge. This attribute was added in
vSphere API 8.0.0.1.</p></li>
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – NSX Policy path of the Edge. This attribute was added in vSphere
API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</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.networks.nsx_client.Edges.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of Edges matching the given filter. This method was
added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Edges.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching Edges for which information should be
returned.
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Edges.FilterSpec</span></code></a>
with all attributes None which means all Edges will be returned.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.list" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.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.namespace_management.networks.nsx_client.Edges.Summary" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Edges.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of Edge summaries matching the given filter.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if one or more fields of the <a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec" title="com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Edges.FilterSpec</span></code></a> is
incorrect.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have <code class="docutils literal notranslate"><span class="pre">System.Read</span></code> privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.nsx_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.namespace_management.networks.service_client">
<span id="com-vmware-vcenter-namespace-management-networks-service-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks.service_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.service_client" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.service_client.DNS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.service_client.</span></span><span class="sig-name descname"><span class="pre">DNS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_domains</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.networks.service_client.DNS" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">DNS</span></code> describes DNS servers and search domains for a given 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">DNS.servers</span></code> is a list of IP addresses that clients may use
for DNS resolution on a given network in priority order.</p>
<p>If empty, no DNS servers will be configured.. This attribute was
added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>search_domains</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>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">DNS.search_domains</span></code> is a list of DNS search domains to be
used on this network.</p>
<p>This field is useful for corporate networks or local domains that
are not publicly resolvable.</p>
<p>If empty, no search domains will be configured.. This attribute was
added in vSphere API 8.0.0.1.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.service_client.NTP">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.service_client.</span></span><span class="sig-name descname"><span class="pre">NTP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.service_client.NTP" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">NTP</span></code> class describes network time protocol configuration for a 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">NTP.servers</span></code> contains a list of servers in priority order
that clients can use for network time protocol. This attribute was
added in vSphere API 8.0.0.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.service_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.service_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks.service_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.namespace_management.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.namespace_management package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.namespace_management.networks.nsx.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespace_management.networks.nsx package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink