mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
340 lines
29 KiB
HTML
340 lines
29 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<title>com.vmware.vcenter.namespace_management.networks.nsx package — vSphere Automation SDK for Python. 8.0.2.0 documentation</title>
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/js/theme.js"></script>
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.vcenter.namespace_management.supervisors package" href="com.vmware.vcenter.namespace_management.supervisors.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vcenter.namespace_management.networks package" href="com.vmware.vcenter.namespace_management.networks.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.2.0
|
|||
|
|
</div>
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|||
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</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"><a href="com.vmware.vcenter.namespace_management.networks.html">com.vmware.vcenter.namespace_management.networks package</a></li>
|
|||
|
|
<li class="breadcrumb-item active">com.vmware.vcenter.namespace_management.networks.nsx package</li>
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
<a href="_sources/com.vmware.vcenter.namespace_management.networks.nsx.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.nsx">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-networks-nsx-package"></span><h1>com.vmware.vcenter.namespace_management.networks.nsx package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.nsx" title="Permalink to this headline"></a></h1>
|
|||
|
|
<section id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
|||
|
|
</section>
|
|||
|
|
<section id="module-com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-networks-nsx-distributed-switches-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client" title="Permalink to this headline"></a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.</span></span><span class="sig-name descname"><span class="pre">Compatibility</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.distributed_switches_client.Compatibility" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Compatibility</span></code> class provides methods to get Namespaces
|
|||
|
|
compatibility 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</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.distributed_switches_client.Compatibility.Summary">
|
|||
|
|
<em class="property"><span class="pre">class</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>, <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">incompatibility_reasons</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.distributed_switches_client.Compatibility.Summary" 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">Compatibility.Summary</span></code> class contains basic and compatibility
|
|||
|
|
information of 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</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>
|
|||
|
|
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Compatibility of this Distributed Switch with the vSphere
|
|||
|
|
Namespaces. This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
|
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of reasons for incompatibility. If empty, this Distributed
|
|||
|
|
Switch is compatible. 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.distributed_switches_client.Compatibility.check">
|
|||
|
|
<span class="sig-name descname"><span class="pre">check</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.distributed_switches_client.Compatibility.check" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns a list of Distributed Switches matching the given filter and
|
|||
|
|
their compatibility information. This method was added in vSphere API
|
|||
|
|
8.0.0.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#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">com.vmware.vcenter.namespace_management.networks.nsx_client.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 filter with all attributes
|
|||
|
|
None which means all Distributed Switches and their compatibility
|
|||
|
|
information will be returned.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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.nsx.distributed_switches_client.Compatibility.Summary" title="com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of Distributed Switches compatibility summaries matching the
|
|||
|
|
given filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 given filter is incorrect.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</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.distributed_switches_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_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.distributed_switches_client.StubFactory" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
<section id="module-com.vmware.vcenter.namespace_management.networks.nsx.edges_client">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-networks-nsx-edges-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks.nsx.edges_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks.nsx.edges_client" title="Permalink to this headline"></a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx.edges_client.</span></span><span class="sig-name descname"><span class="pre">Compatibility</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.edges_client.Compatibility" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Compatibility</span></code> class provides methods to retrieve the basic and
|
|||
|
|
Namespaces compatibility information of Edges. This class was added in
|
|||
|
|
vSphere API 8.0.0.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.Summary">
|
|||
|
|
<em class="property"><span class="pre">class</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">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">incompatibility_reasons</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.edges_client.Compatibility.Summary" 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">Compatibility.Summary</span></code> class contains information about an Edge,
|
|||
|
|
including whether it is compatible with the vCenter Namespaces feature and
|
|||
|
|
incompatibility reasons. 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>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>) – User-friendly identifier of the Edge. This attribute was added in
|
|||
|
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
|
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Compatibility of this Edge with vSphere Namespaces. This attribute
|
|||
|
|
was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
|
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of reasons for incompatibility. If empty, this Edge is
|
|||
|
|
compatible. 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.edges_client.Compatibility.check">
|
|||
|
|
<span class="sig-name descname"><span class="pre">check</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.edges_client.Compatibility.check" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns a list of Edges matching the given filter and their
|
|||
|
|
compatibility information. This method was added in vSphere API
|
|||
|
|
8.0.0.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#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">com.vmware.vcenter.namespace_management.networks.nsx_client.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 given filter with all
|
|||
|
|
attributes None which means all Edges will be returned.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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.nsx.edges_client.Compatibility.Summary" title="com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of Edge compatibility summaries matching the given filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 given filter is incorrect.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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</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.edges_client.StubFactory">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks.nsx.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.nsx.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">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="com.vmware.vcenter.namespace_management.networks.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.namespace_management.networks 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.supervisors.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespace_management.supervisors package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>© Copyright 2023, VMware, Inc..</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
<script>
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|